Sign in
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

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more identities are available in the selected pagination direction.

Changes

Changed in 8 of the 261 revisions of this API.36

  • 9642bb8e4f831See the full diff
    • ●

      removed the optional property data/items/budget/allOf[Budget]/scope/allOf[BudgetScope]/factory from the response with the 200 status

      response-optional-property-removed

    This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a38e9ab597711See the full diff
    • ○

      added the optional property data/items/budget/allOf[Budget]/scope/allOf[BudgetScope]/factory to the response with the 200 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2f27caf6888c1See the full diff
    • ○

      added the optional property data/items/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • bee257c5b2481See the full diff
    • ●

      removed the optional property data/items/budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 801f61a5a0561See the full diff
    • ○

      added the optional property data/items/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 42d5d20625271See the full diff
    • ●

      removed the optional property data/items/budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d418091db1631See the full diff
    • ○

      added the optional property data/items/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

  • 877151607ea92See the full diff
    • ○

      added the new optional query request parameter include_budget

      new-optional-request-parameter

    • ○

      added the optional property data/items/budget to the response with the 200 status

      response-optional-property-added

Of the 261 revisions, 73 have no diff computed.