Skip to main content
GET
/
console
/
organizations
/
{organization_id}
Get Organization
curl --request GET \
  --url https://api.example.com/console/organizations/{organization_id}
{
  "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

Fetch the complete documentation index at: https://docs.pragmatiks.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

organization_id
string
required

Response

Successful Response

Organization record stored in shared SurrealDB namespace.

Represents a Clerk organization synced via webhooks. Stored in the shared namespace because organization data must be accessible before any organization context exists (e.g., during webhook processing).

Identity fields (frozen): organization_id: Clerk organization ID, used as SurrealDB record ID.

Metadata: name: Display name of the organization. slug: URL-friendly organization identifier from Clerk.

State (system-managed): status: Lifecycle status. bootstrap_error: Short human-readable message set when bootstrap fails; cleared on successful retry.

Inherited from PragmaModel: created_at: Creation timestamp (frozen). updated_at: Last update timestamp (mutable).

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