Skip to main content
GET
Get end user

Authorizations

Authorization
string
header
required

WorkOS JWT token. Obtain via WorkOS AuthKit authentication flow. The token must include organization_id claim for organization-scoped endpoints.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource

Response

OK

End user resource representing a user who interacts with embedded AI widgets. Identified by external_id from the embedding site.

id
string
required

Internal end user ID (UUID).

organization_id
string
required

WorkOS organization ID that owns the end user.

external_id
string
required

External user identifier from the embedding site or IDP token.

email
string | null
required

Optional email address provided by the identity provider.

metadata
string | null
required

JSON string with additional end user metadata.

last_activity_at
string<date-time> | null
required

Timestamp of the user's last activity (message sent).

created_at
string<date-time>
required

Timestamp when the end user was created.

updated_at
string<date-time>
required

Timestamp when the end user was last updated.