Skip to main content
GET
/
v2
/
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>",
      "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>"
    }
  ],
  "total": 123
}

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.

Query Parameters

limit
number
page
number

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[]
total
number