List Organizations

curl --request GET \
  --url https://api.studio.prisme.ai/v2/orgs \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "name": "<string>",
      "slug": "<string>",
      "id": "<string>",
      "description": "<string>",
      "photo": "<string>",
      "domains": [
        "<string>"
      ],
      "branding": {
        "version": "<string>",
        "platformName": "<string>",
        "description": "<string>",
        "logo": {
          "light": "<string>",
          "dark": "<string>"
        },
        "favicon": "<string>",
        "colors": {
          "primary": "<string>",
          "secondary": "<string>",
          "accent": "<string>"
        },
        "fonts": {
          "heading": "<string>",
          "body": "<string>"
        },
        "customCssUrl": "<string>",
        "customCssInline": "<string>"
      },
      "navigation": {
        "version": 123,
        "homePage": "<string>",
        "menu": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ],
        "footer": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ],
        "quickActions": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ]
      },
      "joinRules": [
        {
          "rules": [
            {
              "field": "<string>",
              "value": "<string>"
            }
          ],
          "role": "<string>",
          "groups": [
            "<string>"
          ]
        }
      ],
      "defaultRole": "<string>",
      "auth": {
        "anonymous": {
          "enabled": true,
          "role": "<string>",
          "allowedDomains": [
            {
              "domain": "<string>",
              "role": "<string>"
            }
          ]
        }
      },
      "settings": {},
      "subscriptionSlug": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "total": 123
}

GET

orgs

List Organizations

curl --request GET \
  --url https://api.studio.prisme.ai/v2/orgs \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "name": "<string>",
      "slug": "<string>",
      "id": "<string>",
      "description": "<string>",
      "photo": "<string>",
      "domains": [
        "<string>"
      ],
      "branding": {
        "version": "<string>",
        "platformName": "<string>",
        "description": "<string>",
        "logo": {
          "light": "<string>",
          "dark": "<string>"
        },
        "favicon": "<string>",
        "colors": {
          "primary": "<string>",
          "secondary": "<string>",
          "accent": "<string>"
        },
        "fonts": {
          "heading": "<string>",
          "body": "<string>"
        },
        "customCssUrl": "<string>",
        "customCssInline": "<string>"
      },
      "navigation": {
        "version": 123,
        "homePage": "<string>",
        "menu": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ],
        "footer": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ],
        "quickActions": [
          {
            "id": "workspaces",
            "type": "category",
            "label": "Workspaces",
            "icon": "folder",
            "expanded": true,
            "items": [
              {
                "id": "workspaces-list",
                "type": "item",
                "label": "All workspaces",
                "href": "/workspaces"
              },
              {
                "id": "workspaces-create",
                "type": "item",
                "label": "Create workspace",
                "href": "/workspaces/new"
              }
            ]
          }
        ]
      },
      "joinRules": [
        {
          "rules": [
            {
              "field": "<string>",
              "value": "<string>"
            }
          ],
          "role": "<string>",
          "groups": [
            "<string>"
          ]
        }
      ],
      "defaultRole": "<string>",
      "auth": {
        "anonymous": {
          "enabled": true,
          "role": "<string>",
          "allowedDomains": [
            {
              "domain": "<string>",
              "role": "<string>"
            }
          ]
        }
      },
      "settings": {},
      "subscriptionSlug": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit

number

page

number

string

Search organizations by name

status

enum<string>

Filter organizations by status

Available options:

active,

suspended

sort

string

Sort field and direction, e.g. -createdAt

Response

Success

results

object[]

Hide child attributes

results.name

string

required

results.slug

string

required

results.id

string

results.description

string

results.photo

string

results.status

enum<string>

Available options:

active,

suspended

results.domains

string[]

results.branding

object

Hide child attributes

results.branding.version

string

results.branding.platformName

string

results.branding.description

string

results.branding.logo

object

Hide child attributes

results.branding.logo.light

string

results.branding.logo.dark

string

results.branding.favicon

string

results.branding.colors

object

Hide child attributes

results.branding.colors.primary

string

results.branding.colors.secondary

string

results.branding.colors.accent

string

results.branding.fonts

object

Hide child attributes

results.branding.fonts.heading

string

results.branding.fonts.body

string

results.branding.customCssUrl

string

results.branding.customCssInline

string

Organization navigation configuration

Hide child attributes

Schema version number

Route to use as home page (e.g., "/apps/agent-factory"). Must be a valid relative path starting with /. If not set, defaults to the platform default (SecureChat).

Pattern: ^\/[a-zA-Z0-9\-_\/]*$

Main menu items

Hide child attributes

Unique identifier for this menu item

Available options:

category,

item,

divider

Display label (not required for dividers)

Icon name (from lucide-react)

Icon color (CSS color value)

Link destination (for type=item)

Link target

Available options:

_self,

_blank

Whether category is expanded by default

Badge text to show (e.g., "New", "Beta")

Permissions required to see this item

Features attached to this item

Hide child attributes

Available options:

agent,

template

Unique identifier for this feature within the menu item

Display label for the feature

Agent ID (required when type=agent)

Template ID (required when type=template)

Permissions required to see this feature

Visibility rules for subscription tiers/features

Hide child attributes

Child items (for type=category)

Footer menu items

Hide child attributes

Unique identifier for this menu item

Available options:

category,

item,

divider

Display label (not required for dividers)

Icon name (from lucide-react)

Icon color (CSS color value)

Link destination (for type=item)

Link target

Available options:

_self,

_blank

Whether category is expanded by default

Badge text to show (e.g., "New", "Beta")

Permissions required to see this item

Features attached to this item

Hide child attributes

Available options:

agent,

template

Unique identifier for this feature within the menu item

Display label for the feature

Agent ID (required when type=agent)

Template ID (required when type=template)

Permissions required to see this feature

Visibility rules for subscription tiers/features

Hide child attributes

Child items (for type=category)

Quick action buttons

Hide child attributes

Unique identifier for this menu item

Available options:

category,

item,

divider

Display label (not required for dividers)

Icon name (from lucide-react)

Icon color (CSS color value)

Link destination (for type=item)

Link target

Available options:

_self,

_blank

Whether category is expanded by default

Badge text to show (e.g., "New", "Beta")

Permissions required to see this item

Features attached to this item

Hide child attributes

Available options:

agent,

template

Unique identifier for this feature within the menu item

Display label for the feature

Agent ID (required when type=agent)

Template ID (required when type=template)

Permissions required to see this feature

Visibility rules for subscription tiers/features

Hide child attributes

Child items (for type=category)

results.joinRules

object[]

Auto-join rules. Each item is an OR case with AND-chained conditions in rules[]. Example: [{ rules: [{ field: "email", operator: "endsWith", value: "@acme.com" }], role: "member", groups: ["engineering"] }]

Hide child attributes

results.joinRules.rules

object[]

required

Conditions that must ALL match (AND logic)

Hide child attributes

results.joinRules.rules.field

string

required

User attribute to match, supports dot notation for nested fields (e.g. "email", "authData.google.hd")

results.joinRules.rules.operator

enum<string>

required

Match operator. "matches" supports wildcard patterns (e.g. "@acme.com", "" to match any value)

Available options:

equals,

startsWith,

endsWith,

matches

results.joinRules.rules.value

string

required

Value to match against (case-insensitive)

results.joinRules.role

string

Role slug to assign (defaults to org's defaultRole)

results.joinRules.groups

string[]

Group slugs to add the user to

results.defaultRole

string

results.auth

object

Organization-scoped authentication settings

Hide child attributes

results.auth.anonymous

object

Settings for anonymous sessions scoped to this organization. When enabled, callers of POST /v2/login/anonymous can pass this org's slug to receive a token bound to the configured role.

Hide child attributes

results.auth.anonymous.enabled

boolean

required

Whether anonymous sessions are allowed for this org

results.auth.anonymous.role

string

Org role slug (e.g. "org:member" or a custom role) applied to anonymous sessions targeting this org. Required when enabled is true. Owner/Admin and roles with wildcard permissions are forbidden.

results.auth.anonymous.allowedDomains

object[]

Origin hostnames allowed to create anonymous sessions for this org. When non-empty, the gateway:

Auto-resolves orgSlug from the request's Origin/Referer when the body field is omitted (single-org match per hostname).
Rejects /login/anonymous calls whose Origin host does not match any entry — even when the body explicitly carries this orgSlug. Each entry is a hostname (e.g. "chat.acme.com") or a subdomain wildcard (e.g. "*.acme.com") with an optional per-domain role override. When role is set, it takes precedence over auth.anonymous.role for sessions opened from that domain. When empty/undefined, any Origin is accepted but auto-detection is disabled (the body must carry orgSlug).

Hide child attributes

results.auth.anonymous.allowedDomains.domain

string

required

Hostname (e.g. "chat.acme.com") or subdomain wildcard ("*.acme.com")

results.auth.anonymous.allowedDomains.role

string

Optional org role slug applied to anonymous sessions opened from this specific domain. Falls back to the top-level auth.anonymous.role when omitted. Same Owner/Admin/wildcard restrictions apply.

results.settings

object

results.subscriptionSlug

string

results.createdBy

string

results.updatedBy

string

results.createdAt

string

results.updatedAt

string

total

number

Validate Account Create Organization

⌘I