Skip to main content
GET
Get workspace access state

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

id
string
required

Workspace ID

Required string length: 1 - 53

Response

Workspace access state

workspace_id
string
required
Required string length: 1 - 53
status
enum<string>
required
Available options:
active,
payment_grace,
restricted,
suspended,
ended,
reactivating
access_version
integer
required
Required range: x >= 0
accessible
boolean
required
reason
enum<string> | null
required
Available options:
payment_grace,
restricted,
suspended,
ended,
reactivating,
null
reconciliation_status
enum<string>
required
Available options:
pending,
reconciled,
failed
payment_grace_ends_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0
restricted_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0
suspend_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0
ended_at
integer | null
required

Unix timestamp (seconds)

Required range: x >= 0