List User Identities

Get all user identities

Returns a list of all user identities.

Request

This request does not accept any request body parameters.

Sample Request

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

Response

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

PropertyDescription

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, +15555550100)

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

{
  "user_identities": [
    {
      "user_identity_id": "5c945ab5-c75e-4bcb-8e5f-9410061c401f",
      "user_identity_key": null,
      "email_address": "jen@example.com",
      "phone_number": "+15555550106",
      "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": "jean@example.com",
      "phone_number": "+15555550110",
      "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
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.