Skip to main content
GET
List embed users
πŸ”’ Admin only. Requires administrator privileges β€” the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role. Lists the embed users belonging to one embed tenant, cursor-paginated and ordered by email. Alongside the numeric id this API uses, a user carries the externalId your integration knows it by (the id passed to generate-session) whenever it was recorded on the account β€” users provisioned before it was recorded come back without an externalId, though they stay addressable by it everywhere it is accepted as input. Use search to match a substring of the email or external id, or a complete external id, which resolves a user even when the response cannot echo it back.

Authorizations

Authorization
string
header
required

Token authentication. Send Authorization: Bearer <YOUR_TOKEN>.

Path Parameters

embedTenantName
string
required

Name of the embed tenant (the embedTenantName used to generate embed sessions).

Query Parameters

search
string | null

Case-insensitive substring match against the embed user’s email or external id.

after
string
first
integer
Required range: x >= 1

Response

200 - application/json
items
object[]
required
pageInfo
object
required