GET /api/v1/forward/identities
Returns Identity records owned by the authenticated account.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_id | string | No | - | Filter by the integrator’s end-user ID. |
limit | integer | No | 20 | Items per page. Maximum 100. Values above 100 return HTTP 400. |
after_id | string | No | - | Cursor for the next page. Cannot be used with before_id. |
before_id | string | No | - | Cursor for the previous page. Cannot be used with after_id. |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
data | array | Identity objects on the current page. |
first_id | string|null | ID of the first record on this page. |
last_id | string|null | ID of the last record on this page. |
has_more | boolean | Whether more records remain. |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | Invalid pagination parameters or limit above 100. |
| 401 | authentication_error | PAT invalid or expired. |
| 403 | permission_error | Not authorized for this resource. |
Notes
after_idandbefore_idare mutually exclusive.- Soft-deleted identities are not intended for normal use.