List User Identities

Get all user identities

Returns a list of all user identities.

/user_identities/list

post

Returns a list of all user identities.

Authorizations

api_keyclient_sessionpat_with_workspaceconsole_session_with_workspace

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

user_identity_idsstring · uuid[]Optional

Array of user identity IDs by which to filter the list of user identities.

searchstringOptional

String for which to search. Filters returned user identities to include all records that satisfy a partial match using full_name, phone_number, email_address or user_identity_id.

credential_manager_acs_system_idstring · uuidOptional

acs_system_id of the credential manager by which you want to filter the list of user identities.

limitintegerOptional

Maximum number of records to return per page.

Default: 500

created_beforestring · date-timeOptional

Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.

page_cursorstring · nullableOptional

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

/user_identities/list

HTTPcURLJavaScriptPython

POST /user_identities/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "user_identity_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "search": "text",
  "credential_manager_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "limit": 500,
  "created_before": "2026-01-30T19:41:25.192Z",
  "page_cursor": "text"
}

{
  "user_identities": [
    {
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_identity_key": "text",
      "email_address": "[email protected]",
      "phone_number": "text",
      "display_name": "text",
      "full_name": "text",
      "created_at": "2026-01-30T19:41:25.192Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "errors": [
        {
          "created_at": "2026-01-30T19:41:25.192Z",
          "message": "text",
          "error_code": "issue_with_acs_user",
          "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
          "acs_system_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "warnings": [
        {
          "created_at": "2026-01-30T19:41:25.192Z",
          "message": "text",
          "warning_code": "being_deleted"
        }
      ],
      "acs_user_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "pagination": {
    "next_page_cursor": "text",
    "has_next_page": true,
    "next_page_url": "https://example.com"
  },
  "ok": true
}

Request

This request does not accept any request body parameters.

Sample Request

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/user_identities/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -d ''

Go

Response

Returns a user_identities array, in which each returned user identity (user_identity) contains the following properties:

Property	Description
user_identity_id	ID of the user identity
user_identity_key	Unique key for the user identity
email_address	Unique email address for the user identity
phone_number	Unique phone number for the user identity in E.164 format (for example, [phone])
display_name	Display name for the user identity
full_name	Full name of the user associated with the user identity
created_at	Date and time at which the user identity was created
workspace_id	ID of the workspace that contains the user identity

This response also includes a Boolean ok status indicator.

Sample Response

JSON

{
  "user_identities": [
    {
      "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
      "user_identity_key": null,
      "email_address": "[email protected]",
      "phone_number": "[phone]",
      "display_name": "Jen Smith",
      "full_name": "Jen Smith",
      "created_at": "2024-01-04T18:26:04.992Z",
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
    },
    {
      "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a",
      "user_identity_key": "jean_doe",
      "email_address": "[email protected]",
      "phone_number": "[phone]",
      "display_name": "Jean Doe",
      "full_name": "Jean Doe",
      "created_at": "2024-01-11T05:37:50.264Z",
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be"
    },
    ...
  ],
  "ok": true
}