Skip to main content
Identities

List identities

List Forward identities under the current account with cursor pagination.

GET /api/v1/forward/identities Returns Identity records owned by the authenticated account.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Query parameters

ParameterTypeRequiredDefaultDescription
external_idstringNo-Filter by the integrator's end-user ID.
identity_idsstring|string[]No-Filter by multiple Identity IDs. Accepts a comma-separated value or repeated query parameters, with a maximum of 100 unique IDs.
searchstringNo-Match an Identity ID, name, or external ID.
enabledbooleanNo-Filter by enabled state. A non-boolean value returns HTTP 400.
limitintegerNo20Items per page. Maximum 100; larger values are capped at 100.
after_idstringNo-Cursor for the next page. Cannot be used with before_id.
before_idstringNo-Cursor for the previous page. Cannot be used with after_id.

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/identities?external_id=user_456&limit=20' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK 
{
  "data": [
    {
      "id": "idn_019eabc123",
      "external_id": "user_456",
      "name": "Example User",
      "identity_type": "normal",
      "enabled": true,
      "metadata": {},
      "created_at": "2026-06-18T10:00:00Z",
      "updated_at": "2026-06-18T10:00:00Z"
    }
  ],
  "first_id": "idn_019eabc123",
  "last_id": "idn_019eabc123",
  "has_more": false
}

Response fields

FieldTypeDescription
dataarrayIdentity objects on the current page.
first_idstring|nullID of the first record on this page.
last_idstring|nullID of the last record on this page.
has_morebooleanWhether more records remain.
data[].idstringForward Identity ID.
data[].external_idstringEnd-user ID from the integrator's system.
data[].namestringIdentity display name.
data[].identity_typestringIdentity type. A standard Identity returns normal.
data[].enabledbooleanWhether the Identity can be used for new operations.
data[].metadataobjectCustom metadata.
data[].created_atstringCreation time in RFC 3339 format.
data[].updated_atstringMost recent update time in RFC 3339 format.

Errors

HTTPTypeCodeTrigger
400--limit is invalid, both after_id and before_id are provided, enabled is not a boolean, or identity_ids is invalid.
401authentication_errorauthentication_requiredThe PAT or SAT is invalid or expired.
403permission_error-The caller is not authorized to access this resource.

Notes

  • after_id and before_id are mutually exclusive.
  • Values of limit above 100 are capped at 100 and do not return HTTP 400.
  • search matches the Identity ID, name, and external ID.
  • Deleted Identities must not be used for normal business operations.

Create an identity

Get an identity

First steps
Define your agent
Configure agent environment
Delegate work to your agent
Agent integrations
Manage agent context
Account
Best Practices
Announcements
API reference