curl --request GET \
--url https://api.studio.prisme.ai/v2/orgs/{orgSlug} \
--header 'Authorization: Bearer <token>'{
"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>"
}Get Organization
Get an organization by slug
curl --request GET \
--url https://api.studio.prisme.ai/v2/orgs/{orgSlug} \
--header 'Authorization: Bearer <token>'{
"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>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Success
active, suspended Hide child attributes
Hide child attributes
Organization navigation configuration
Hide child attributes
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).
^\/[a-zA-Z0-9\-_\/]*$Main menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
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
_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
Hide child attributes
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
Child items (for type=category)
Footer menu items
Hide child attributes
Hide child attributes
Unique identifier for this menu item
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
_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
Hide child attributes
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
Child items (for type=category)
Quick action buttons
Hide child attributes
Hide child attributes
Unique identifier for this menu item
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
_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
Hide child attributes
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
Child items (for type=category)
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
Hide child attributes
Conditions that must ALL match (AND logic)
Hide child attributes
Hide child attributes
User attribute to match, supports dot notation for nested fields (e.g. "email", "authData.google.hd")
Match operator. "matches" supports wildcard patterns (e.g. "@acme.com", "" to match any value)
equals, startsWith, endsWith, matches Value to match against (case-insensitive)
Role slug to assign (defaults to org's defaultRole)
Group slugs to add the user to
Organization-scoped authentication settings
Hide child attributes
Hide child attributes
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
Hide child attributes
Whether anonymous sessions are allowed for this org
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.
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
roleis set, it takes precedence overauth.anonymous.rolefor 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
Hide child attributes
Hostname (e.g. "chat.acme.com") or subdomain wildcard ("*.acme.com")
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.
Was this page helpful?