GET /api/v2/users/{user_id}/identities
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
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id |
Integer | Yes |
The id of the user |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Object | No |
Cursor-based pagination parameters (JSON:API style). Supports nested parameters:
Example: |
include_boundary_indicators |
Boolean | No |
When true, includes Only valid with cursor pagination (page[size], page[after], page[before]). |
sort |
String | No |
Field to sort results by. Prefix with When used with cursor pagination, this determines the cursor ordering. Example: |
type[] |
Array | No |
Filters results by one or more identity types using the format |
include_item_cursors |
Boolean | No |
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.