Skip to main content
GET
List profiles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Query Parameters

include
string

Comma-separated list of relationships to include. Allowed: current_department, current_primary_appointment, primary_appointments, additional_appointments, addresses, user

sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at, display_name, legal_first_name, legal_last_name

filter[key]
string

Filter results. Available filters: legal_first_name, employee_id, employee_ids (filter profiles by employee id for a given configuration, example filter[employee_ids][UID]=12345), employee_ids.in (filter profiles by employee id in a comma-separated list for a given configuration, example filter[employee_ids.in][UID]=12345,67890), email, display_name, display_name.neq, display_name.cont (case-insensitive substring match), display_name.in (comma-separated list), display_name.nin (comma-separated list), legal_maiden_name, legal_maiden_name.neq, legal_maiden_name.cont (case-insensitive substring match), legal_maiden_name.in (comma-separated list), legal_maiden_name.nin (comma-separated list), suffix, suffix.neq, suffix.cont (case-insensitive substring match), suffix.in (comma-separated list), suffix.nin (comma-separated list), birthdate, birthdate.neq, birthdate.lt, birthdate.lte, birthdate.gt, birthdate.gte, deceased_on, deceased_on.neq, deceased_on.lt, deceased_on.lte, deceased_on.gt, deceased_on.gte, racial_identity, racial_identity.neq, racial_identity.cont (case-insensitive substring match), racial_identity.in (comma-separated list), racial_identity.nin (comma-separated list), current_department, current_department.exists, current_primary_appointment, current_primary_appointment.exists, primary_appointments, additional_appointments, addresses, user. Custom fields can also be filtered with filter[custom_fields.field_name].

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

profiles found

data
object[]
required
meta
object