Skip to main content
GET
Get User Info

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Response

Successful Response

user_id
string
required

The unique identifier of the user.

subscription
SubscriptionResponseModel · object
required

Details of the user's subscription.

is_onboarding_completed
boolean
required

Whether the user's onboarding is completed.

is_onboarding_checklist_completed
boolean
required

Whether the user's onboarding checklist is completed.

created_at
integer
required

The unix timestamp of the user's creation. 0 if the user was created before the unix timestamp was added.

seat_type
enum<string>
required

The seat type of the user.

Available options:
workspace_admin,
workspace_member,
workspace_lite_member
show_compliance_terms
boolean
default:false

Whether to show compliance terms (ToS, Privacy Policy) during onboarding. Set for users signing up from the marketing site.

first_name
string | null

First name of the user.

last_name
string | null

Last name of the user.

display_name
string | null

Display name of the user.

avatar_url
string | null

Profile picture URL for the user.

is_api_key_hashed
boolean
default:false

Whether the user's API key is hashed.