console

List Organizations

List every organization on the platform.

Replacement for the deleted customer-realm GET /organizations/ endpoint. Gated on require_console_user so only a pragmatiks-employee session token reaches it — the Clerk SDK’s JWKS check rejects customer-realm tokens, and require_console_user rejects ConsoleMachine M2M tokens with 403. This closes the tenant-enumeration primitive that a customer org:admin used to hold against the old endpoint.

Args: user: Authenticated ConsoleUser (unused beyond the gate). shared_client: Shared-namespace SurrealDB client.

Returns: List of organization records ordered by name.

GET

console

organizations

List Organizations

curl --request GET \
  --url https://api.example.com/console/organizations

[
  {
    "organization_id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "bootstrapping",
    "bootstrap_error": "<string>"
  }
]

Response

200 - application/json

Successful Response

organization_id

string

required

name

string

required

slug

string

required

created_at

string<date-time>

updated_at

string<date-time>

status

enum<string>

default:bootstrapping

Lifecycle status of an organization.

Bootstrap states: BOOTSTRAPPING: Organization row exists, bootstrap worker has not yet finished provisioning tenant namespace resources. READY: Organization is fully provisioned and usable. BOOTSTRAP_FAILED: Bootstrap worker exhausted its retry budget. Recovery is manual during private beta: operators contact support or clear the failure via direct SurrealDB intervention.

Teardown states: DEACTIVATING: Cleanup worker is tearing down tenant resources. DELETED: Organization fully cleaned up.

Available options:

bootstrapping,

ready,

bootstrap_failed,

deactivating,

deleted

bootstrap_error

string | null

Get OrganizationRead any organization's record by id. Cross-tenant read for support and operations use cases. Gated identically to :func:`list_organizations` so the same JWKS boundary keeps the endpoint off-limits to customer principals. Callers who only need their own organization should hit the customer-realm ``GET /organizations/me`` instead. Args: organization_id: Clerk organization id to look up. user: Authenticated ConsoleUser (unused beyond the gate). shared_client: Shared-namespace SurrealDB client. Returns: Organization record. Raises: OrganizationNotFoundError: If no organization has this id.

List Organizations

curl --request GET \
  --url https://api.example.com/console/organizations

[
  {
    "organization_id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "bootstrapping",
    "bootstrap_error": "<string>"
  }
]

Documentation Index

Response