Identities
List identities
Retrieves a paginated list of identities in your workspace. Use pagination parameters to navigate through large identity lists efficiently.
get/v2/identities
Query parameters
limitinteger
starting_afterstring
Cursor for forward pagination. Set to the _id of the last item from the previous page.
ending_beforestring
Cursor for backward pagination. Set to the _id of the first item from the previous page.
searchstring
Case-insensitive search text matched against identity profile fields.
filter_by.tagsstring[]
Return only identities that have at least one of these tags.
include_metricsboolean
Include aggregate usage metrics on each returned identity.
sort_by'IDENTITY_SORT_FIELD_UNSPECIFIED' | 'IDENTITY_SORT_FIELD_DISPLAY_NAME' | 'IDENTITY_SORT_FIELD_UPDATED'
Field used to order the list.
include_budgetboolean
When true, embed each identity's identity-scoped budget (config and limits only, no live usage) on the returned records. Adds one budget lookup for the page; omit to skip it.
Response
OK