Skip to main content
GET
Get current user

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Response

User profile

allowed_platforms
string[]
Example:
avatar_url
string
Example:

"https://example.com/avatar.jpg"

beta_tester
boolean
Example:

false

billing_block_reason
string

BillingBlockReason is why access is paused, empty when it is not. "past_due": a payment failed, and settling it restores access. "ban": the account was suspended for a Terms of Service violation. Paying does not lift it, and every route except this one returns 403 auth.suspended. Contact support to appeal.

Example:

"past_due"

billing_blocked
boolean

BillingBlocked is true when API access and webhook delivery are paused. Read BillingBlockReason to tell why and whether paying lifts it.

Example:

false

billing_blocked_at
string

BillingBlockedAt is when the block began, or null when not blocked.

email
string
Example:

"user@example.com"

experiment_enrolled
boolean

ExperimentEnrolled is true only when ExperimentVariant was assigned by the experiment itself. False means the "control" above is a fallback (not enrolled, flag off, or evaluation failed) and must not be recorded as the caller's arm.

Example:

false

experiment_variant
string

ExperimentVariant is the caller's variant for staged feature rollouts: "control" or "treatment". "control" unless the caller is enrolled.

Example:

"control"

facebook_page_selection
boolean

FacebookPageSelection, when true, enables the Facebook Page selection connect flow in the dashboard. Read-only here.

Example:

false

id
string
Example:

"550e8400-e29b-41d4-a716-446655440000"

job_role
string

JobRole is what best describes the user, as answered during onboarding. Null until answered.

Example:

"Founder / CEO"

lock_accounts_to_brand
boolean

LockAccountsToBrand, when true, rejects connecting a social account that is already connected to another of your brands (409 account.already_linked) instead of moving it. Default false.

Example:

false

onboarding
boolean
Example:

true

plan
string
Example:

"free"

role
string

Role is the caller's team role: "admin", "developer", or "" for the account Owner, who holds no Role. An API key and an OAuth token both read "".

Example:

"admin"

use_case
string
Example:

"Managing clients' accounts (agency)"