Skip to main content
GET
Get End User Info

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

end_user_id
string<uuid>
required

ID of the end user to look up.

Response

End user retrieved successfully.

id
string<uuid>

End user ID.

tenant_id
string<uuid>

Tenant ID.

app_id
string<uuid> | null

Application ID.

type
string

End user type. Always service-api for Service API users.

external_user_id
string | null

The user identifier provided in API requests (e.g., the user field in Send Chat Message).

name
string | null

End user name.

is_anonymous
boolean

Whether the user is anonymous. true when no user identifier was provided in the original API request.

session_id
string

Session identifier. Defaults to the external_user_id value.

created_at
string<date-time>

Creation timestamp.

updated_at
string<date-time>

Last update timestamp.