List User Identities

Get all user identities

Returns a list of all user identities.

/user_identities/list

POSThttps://connect.getseam.com/user_identities/list

Authorization

api_keyclient_sessionpat_with_workspaceconsole_session

Body

application/json

credential_manager_acs_system_idstring (uuid)

Response

200400401

OK

Body

application/json

user_identities*array of user_identity (object)

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/user_identities/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "user_identities": [
    {
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_identity_key": "text",
      "email_address": "[e-mail]",
      "phone_number": "text",
      "display_name": "text",
      "full_name": "text",
      "created_at": "2024-09-10T04:43:26.346Z",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "ok": false
}

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

userIdentities, err := client.UserIdentities.List(context.Background())
if err != nil {
    return err
}
fmt.Println(userIdentities)
return nil

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": "[e-mail]",
      "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": "[e-mail]",
      "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
}