Get a User Identity

Get a specified user identity

Returns a specified user identity.

/user_identities/get

POSThttps://connect.getseam.com/user_identities/get
Authorization
Body
one of
Response

OK

Body
user_identity*user_identity (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/user_identities/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();
Response
{
  "user_identity": {
    "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_identity_key": "text",
    "email_address": "name@gmail.com",
    "phone_number": "text",
    "display_name": "text",
    "full_name": "text",
    "created_at": "2024-07-14T17:51:45.590Z",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "ok": false
}

Request

Specify the desired user identity by including the corresponding user_identity_id in the request body.

Request Body Parameters

ParameterTypeDescription

user_identity_id

String Required

ID of the desired user identity

Sample Request

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/user_identities/get' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "user_identity_id": "48500a8e-5e7e-4bde-b7e5-0be97cae5d7a"
}'

Response

Returns a user_identity containing 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_identity": {
    "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.