List Organizations

List organizations for the authenticated user

GET /v2/orgs

List Organizations

cURL

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.studio.prisme.ai/v2/orgs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/orgs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "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
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

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

Query Parameters

limit · number

page · number

search · 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

200

application/json

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

results. navigation · object

Organization navigation configuration

Hide child attributes

results.navigation. version · integer

Schema version number

results.navigation. homePage · string

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\-_\/]*$

results.navigation. menu · object[]

Main menu items

Hide child attributes

results.navigation.menu. id · string · required

Unique identifier for this menu item

results.navigation.menu. type · enum<string> · required

Available options: category, item, divider

results.navigation.menu. label · string

Display label (not required for dividers)

results.navigation.menu. icon · string

Icon name (from lucide-react)

results.navigation.menu. color · string

Icon color (CSS color value)

results.navigation.menu. href · string

Link destination (for type=item)

results.navigation.menu. target · enum<string>

Link target

Available options: _self, _blank

results.navigation.menu. expanded · boolean

Whether category is expanded by default

results.navigation.menu. badge · string

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

results.navigation.menu. permissions · string[]

Permissions required to see this item

results.navigation.menu. features · object[]

Features attached to this item

Hide child attributes

results.navigation.menu.features. type · enum<string> · required

Available options: agent, template

results.navigation.menu.features. slug · string · required

Unique identifier for this feature within the menu item

results.navigation.menu.features. label · string · required

Display label for the feature

results.navigation.menu.features. agentId · string

Agent ID (required when type=agent)

results.navigation.menu.features. templateId · string

Template ID (required when type=template)

results.navigation.menu.features. permissions · string[]

Permissions required to see this feature

results.navigation.menu. visibility · object

Visibility rules for subscription tiers/features

Hide child attributes

results.navigation.menu.visibility. tiers · string[]

results.navigation.menu.visibility. features · string[]

results.navigation.menu. items · object[]

Child items (for type=category)

results.navigation. footer · object[]

Footer menu items

Hide child attributes

results.navigation.footer. id · string · required

Unique identifier for this menu item

results.navigation.footer. type · enum<string> · required

Available options: category, item, divider

results.navigation.footer. label · string

Display label (not required for dividers)

results.navigation.footer. icon · string

Icon name (from lucide-react)

results.navigation.footer. color · string

Icon color (CSS color value)

results.navigation.footer. href · string

Link destination (for type=item)

results.navigation.footer. target · enum<string>

Link target

Available options: _self, _blank

results.navigation.footer. expanded · boolean

Whether category is expanded by default

results.navigation.footer. badge · string

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

results.navigation.footer. permissions · string[]

Permissions required to see this item

results.navigation.footer. features · object[]

Features attached to this item

Hide child attributes

results.navigation.footer.features. type · enum<string> · required

Available options: agent, template

results.navigation.footer.features. slug · string · required

Unique identifier for this feature within the menu item

results.navigation.footer.features. label · string · required

Display label for the feature

results.navigation.footer.features. agentId · string

Agent ID (required when type=agent)

results.navigation.footer.features. templateId · string

Template ID (required when type=template)

results.navigation.footer.features. permissions · string[]

Permissions required to see this feature

results.navigation.footer. visibility · object

Visibility rules for subscription tiers/features

Hide child attributes

results.navigation.footer.visibility. tiers · string[]

results.navigation.footer.visibility. features · string[]

results.navigation.footer. items · object[]

Child items (for type=category)

results.navigation. quickActions · object[]

Quick action buttons

Hide child attributes

results.navigation.quickActions. id · string · required

Unique identifier for this menu item

results.navigation.quickActions. type · enum<string> · required

Available options: category, item, divider

results.navigation.quickActions. label · string

Display label (not required for dividers)

results.navigation.quickActions. icon · string

Icon name (from lucide-react)

results.navigation.quickActions. color · string

Icon color (CSS color value)

results.navigation.quickActions. href · string

Link destination (for type=item)

results.navigation.quickActions. target · enum<string>

Link target

Available options: _self, _blank

results.navigation.quickActions. expanded · boolean

Whether category is expanded by default

results.navigation.quickActions. badge · string

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

results.navigation.quickActions. permissions · string[]

Permissions required to see this item

results.navigation.quickActions. features · object[]

Features attached to this item

Hide child attributes

results.navigation.quickActions.features. type · enum<string> · required

Available options: agent, template

results.navigation.quickActions.features. slug · string · required

Unique identifier for this feature within the menu item

results.navigation.quickActions.features. label · string · required

Display label for the feature

results.navigation.quickActions.features. agentId · string

Agent ID (required when type=agent)

results.navigation.quickActions.features. templateId · string

Template ID (required when type=template)

results.navigation.quickActions.features. permissions · string[]

Permissions required to see this feature

results.navigation.quickActions. visibility · object

Visibility rules for subscription tiers/features

Hide child attributes

results.navigation.quickActions.visibility. tiers · string[]

results.navigation.quickActions.visibility. features · string[]

results.navigation.quickActions. items · object[]

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:

1. Auto-resolves orgSlug from the request's Origin/Referer when the body field is omitted (single-org match per hostname).
2. 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