BObotbrains-io
User Identities

List Identities

Changed on

Returns a list of identities for the given user.

Use the first endpoint if authenticating as an agent. Use the second if authenticating as an end user. End users can only list email and phone number identities.

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Returns a maximum of 100 records per page for cursor pagination.

Allowed For

  • Agents
  • Verified end users
get/api/v2/users/{user_id}/identities

Request

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response

Changes

  • edbf399da815Revision changes
    • info

      added the new optional query request parameter page[after]

    • info

      added the new optional query request parameter page[before]

    • info

      added the new optional query request parameter page[size]