Get Organization by ID

Retrieves a single Organization by its unique identifier. Organizations are the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

GET /api/organizations/{id}

Get Organization by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/organizations/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "authGroupLink": {
    "authGroup": "<string>"
  },
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "defaultToPrivateTemplates": true,
  "description": "Document processing organization for Acme Corp.",
  "enterpriseOrganization": true,
  "features": {},
  "hasImage": true,
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "memory": {
    "orderedDashboards": [
      "<string>"
    ]
  },
  "name": "Acme Corp",
  "organizationStatus": "ACTIVE",
  "properties": {},
  "publicAccess": true,
  "searchText": "<string>",
  "slug": "acme-corp",
  "stripeCustomerId": "<string>",
  "supportAccess": true,
  "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "550e8400e29b41d4a716446655440000",
  "archived": true
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id · string<uuid> · required

Unique identifier (UUID) of the resource.

Response

200

application/json

The Organization

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

authGroupLink · object · required

Show child attributes

changeSequence · integer<int32> · required

Optimistic locking version number, incremented on each update.

createdOn · string<date-time> · required

Timestamp when the organization was created.

defaultToPrivateTemplates · boolean · required

Whether new templates default to private access.

description · string · required

Human-readable description of the organization.

Example:

"Document processing organization for Acme Corp."

enterpriseOrganization · boolean | null · required

Whether this is an enterprise-tier organization.

features · object | null · required

Feature flags enabled for the organization.

Show child attributes

hasImage · boolean · required

Whether the organization has a profile image.

id · string · required

Unique identifier (UUID) for the organization.

Example:

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

memory · object · required

Organization-level memory and configuration.

Show child attributes

name · string · required

Display name of the organization.

Example:

"Acme Corp"

organizationStatus · string · required

Current status of the organization (e.g., ACTIVE, SUSPENDED).

Example:

"ACTIVE"

properties · object | null · required

Arbitrary key-value properties for the organization.

Show child attributes

publicAccess · boolean · required

Whether the organization is publicly visible.

searchText · string · required

Full-text searchable representation of the organization.

slug · string · required

URL-friendly identifier, 3-100 characters. Automatically lowercased. Pattern: ^[a-z0-9-]+$

Example:

"acme-corp"

stripeCustomerId · string · required

supportAccess · boolean · required

Whether Kodexa support has been granted access.

supportAccessExpiresAt · string<date-time> | null · required

When support access expires.

updatedOn · string<date-time> · required

Timestamp when the organization was last updated.

uuid · string · required

Secondary UUID identifier.

Example:

"550e8400e29b41d4a716446655440000"

archived · boolean | null