List User Identities

Returns a list of all user identities.

POST /user_identities/list

JavaScript

Seam SDK

await seam.userIdentities.list();

/*
[
  {
    "created_at": "2025-06-16T16:54:17.946546Z",
    "display_name": "Jane Doe",
    "email_address": "[e-mail]",
    "errors": [],
    "full_name": "Jane Doe",
    "phone_number": "[phone]",
    "user_identity_id": "43947360-cdc8-4db6-8b22-e079416d1d8b",
    "user_identity_key": "jane_doe",
    "warnings": [],
    "workspace_id": "b7e0a4e0-1044-4319-9a0b-42b642b68c7f"
  }
]
*/

200

{
  "ok": true,
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "<string>",
    "next_page_url": "<string>"
  },
  "user_identities": [
    {
      "acs_user_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "display_name": "<string>",
      "email_address": "[e-mail]",
      "errors": [
        {
          "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "error_code": "issue_with_acs_user",
          "message": "<string>"
        }
      ],
      "full_name": "<string>",
      "phone_number": "<string>",
      "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "user_identity_key": "<string>",
      "warnings": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "message": "<string>",
          "warning_code": "being_deleted"
        }
      ],
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

api_keyclient_sessionpat_with_workspaceconsole_session_with_workspace

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

created_before · string<date-time>

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

credential_manager_acs_system_id · string<uuid>

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

limit · integer · default: 500

Maximum number of records to return per page.

Required range: x > 0

page_cursor · string | null

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

search · string

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.

user_identity_ids · string<uuid>[]

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

Response

200

application/json

OK

ok · boolean · required

pagination · object · required

Information about the current page of results.

Show child attributes

user_identities · object[] · required

Show child attributes