Skip to main content
GET
/
v2
/
orgs
/
{orgSlug}
cURL
curl --request GET \
  --url https://api.eda.prisme.ai/v2/orgs/{orgSlug} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "slug": "<string>",
  "id": "<string>",
  "description": "<string>",
  "photo": "<string>",
  "status": "active",
  "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": "<string>",
        "type": "category",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "target": "_self",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "type": "agent",
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "footer": [
      {
        "id": "<string>",
        "type": "category",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "target": "_self",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "type": "agent",
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ],
    "quickActions": [
      {
        "id": "<string>",
        "type": "category",
        "label": "<string>",
        "icon": "<string>",
        "color": "<string>",
        "href": "<string>",
        "target": "_self",
        "expanded": true,
        "badge": "<string>",
        "permissions": [
          "<string>"
        ],
        "features": [
          {
            "type": "agent",
            "slug": "<string>",
            "label": "<string>",
            "agentId": "<string>",
            "templateId": "<string>",
            "permissions": [
              "<string>"
            ]
          }
        ],
        "visibility": {
          "tiers": [
            "<string>"
          ],
          "features": [
            "<string>"
          ]
        },
        "items": "<array>"
      }
    ]
  },
  "joinRules": [
    {
      "rules": [
        {
          "field": "<string>",
          "operator": "equals",
          "value": "<string>"
        }
      ],
      "role": "<string>",
      "groups": [
        "<string>"
      ]
    }
  ],
  "defaultRole": "<string>",
  "settings": {},
  "subscriptionSlug": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt

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

Authorizations

Authorization
string
header
required

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

Path Parameters

orgSlug
string
required

Response

Success

name
string
required
slug
string
required
id
string
description
string
photo
string
status
enum<string>
Available options:
active,
suspended
domains
string[]
branding
object
navigation
object

Organization navigation configuration

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

defaultRole
string
settings
object
subscriptionSlug
string
createdBy
string
updatedBy
string
createdAt
string
updatedAt
string