Skip to main content
GET
List profiles

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Query Parameters

page
integer
default:1

The current page cursor to fetch, starting at 1

perPage
integer
default:20

The number of records to fetch per page, max 100

query
string

Filter by partial matches across profile name, email, and external ID.

external_id
string

Filter by profiles whose externalId matches the supplied value exactly, ignoring letter case. Partial values do not match; use query, which searches name, email, and external ID, to match external IDs partially. The ID is supplied during the onboarding or profile creation API request by an external system such as a custom admin system or CRM.

name
string

Filter by partial matches to the full name.

email
string

Filter by partial matches to the profile's email address.

address1
string

Filter by partial matches to address line 1.

address2
string

Filter by partial matches to address line 2.

date_of_birth
string

Filter by profiles with a certain date of birth, in \

sex
string

Filter by profiles with a certain sex, as reported on their onboarding documentation. Should be \

address_city
string

Filter by partial matches to the profile's known city of residence.

address_state
string

Filter by partial matches to the profiles' known state/province of residence.

country
string

Filter by partial matches to the profiles' known country of residence.

nationality
string

Filter by partial matches to a country of citizenship.

tasks
string

Filter by tasks (comma-separated)

kind
string

Filter by profile kind

status
string

Filter by profiles that are in a certain workflow status (example: \

archived
string

Filter by profiles based on archived status. Omit to show all profiles (default behaviour).

flag_names
string

Filter by profiles with certain flags (comma-separated). Example: \

last_screened_time_start
string

Filter by last screened time start

last_screened_time_end
string

Filter by last screened time end

monitored
string

Filter by monitored status

profile_group_ids
string

Filter by profiles assigned to any of the provided profile group IDs. Use comma-separated IDs for multiple groups.

sort_key
string
default:createdAt

The key to sort records by. This should match an existing key on the profile schema. Default: \

sort_direction
string
default:desc

The direction to sort. Should be \

Body

application/json

The body is of type object.

Response

200 - application/json

Profiles listed successfully

msg
string
Example:

"OK"

result
object
status
integer
Example:

200