API reference

Session

Who is signed in, and which workspaces they belong to.

  1. GET/v1/me
GET/v1/me

The signed-in user and their workspaces

Needs: A signed-in panel session, sent as Authorization: Bearer <access token>.

Responses
StatusBodyWhen
200MeResponseDto
401—Missing or invalid access token
200 body · MeResponseDto
FieldTypeWhat it is
user requiredMeUserDto
user.id requiredstring
user.email requiredstring
user.emailVerified requiredstring | nullISO timestamp of email verification, or null if unverified.
organizations requiredMeOrganizationDto[]
organizations[].id requiredstring
organizations[].name requiredstring
organizations[].slug requiredstring
organizations[].plan requiredstring
organizations[].trialEndsAt requiredstring | nullWhen a demo workspace stops working (ISO-8601). Null on paid plans.
organizations[].cancelAt requiredstring | nullWhen the workspace's subscription is set to end instead of renewing (ISO-8601), because a cancellation was scheduled in the billing portal. Null while it renews.
organizations[].role required"owner" | "admin" | "editor" | "analyst" | "viewer"The caller's role in this organization.
organizations[].permissions requiredPermissionsDtoThe caller's permission matrix for this organization (derived from role).
organizations[].scope requiredMemberScopeDto[] | nullThe clients the caller is limited to in this workspace, or null for access to the whole workspace.
features requiredFeaturesDto

Next groupSign-in