Skip to main content
GET
Read Staff

Filtering

This endpoint accepts filter and sort query parameters. See Filtering, sorting, and search for paging and for the shared search_with, custom_field, and json_contains filters.

Examples

Operators

Filter attributes

Each attribute above is also a valid sort key, for example ?sort=-created_at for descending order. Dot notation filters on a related record. Use not_has to exclude rows that have a matching related record. Related attributes are filter only, not sort keys.

Search attributes

filter[search] runs one partial match term across first_name, last_name, email, mobile_phone, profile_type. A record matches when any one of those attributes contains the term.

Custom field filters

Profile records carry custom fields, so this endpoint also accepts filter[custom_field][namespace:handle].

Path Parameters

handle
string
required

Query Parameters

page[size]
string

Response

Array of Profile

data
Profile · object[]
required