Skip to main content
POST
Create the verified workspace and sign in

Headers

X-Workspace-Onboarding-Session
string
required

Opaque resume credential returned after mailbox or invitation authentication. It is bound to this setup session and expires or rotates during handoff.

Required string length: 64

Path Parameters

public_id
string<uuid>
required

Public setup-session UUID.

Response

Operation result.

post_auth_path
string
required
Example:

"/app/onboarding"

onboarding_complete
boolean
required
Example:

true

status
string
Example:

"success"

client_status
enum<string>

Current billing access state.

Available options:
active,
closed,
lead,
delinquent,
due
Example:

"active"

organization
string
Example:

"Example Nonprofit"

website
string | null
Example:

"https://example.org"

token
string

New administrator bearer access token. Treat as a secret.

Example:

"example-access-token"

org_created_at
string
Example:

"2024-06-15T09:50:00Z"

last_payment_date
string | null

Last successful billing payment timestamp, when available.

last_payment_amount
any | null

Latest billing payment amount or null.

monthly_payment
any

Current resolved recurring billing amount.

user
User · object

An admin user — staff member of a client organization. Authenticates via Laravel Passport (bearer JWT) for the admin web app, and may also issue API keys (via ApiKey) for server-to-server integrations. Permissions are stored as JSON keyed by feature; group membership (group_id) supplies a baseline permission set on top of the per-user override.

plan
string

Resolved billing plan key.

Example:

"growth"

pricing_tier
string | null
Example:

"growth"

pricing_quote
object
entitlements
object
permissions
object
access_manifest
object