Skip to main content
GET
/
workspaces
List workspaces
curl --request GET \
  --url https://core.ravenna.ai/api/workspaces \
  --header 'x-ravenna-api-token: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "organizationId": "<string>",
    "creatorId": "<string>",
    "private": true,
    "slackBotIconUrl": "<string>",
    "slackBotUsername": "<string>",
    "slackEmojiActions": "<any>",
    "brandIcon": "<string>",
    "brandColor": "<string>",
    "defaultQueueId": "<string>",
    "slackTriageChannels": [
      {
        "workspace": {
          "id": "<string>",
          "name": "<string>"
        },
        "id": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "private": true,
        "deletedAt": "<string>",
        "type": "DM",
        "channelId": "<string>",
        "channelName": "<string>",
        "mirrorTs": "<string>",
        "appId": "<string>",
        "workspaceId": "<string>",
        "queue": {
          "id": "<string>",
          "name": "<string>",
          "emoji": "<string>",
          "workspaceId": "<string>"
        },
        "queueId": "<string>",
        "agentId": "<string>",
        "slackUserId": "<string>",
        "userId": "<string>",
        "ticketId": "<string>",
        "contextTeamId": "<string>",
        "app": {
          "id": "<string>",
          "appId": "<string>",
          "accessToken": "<string>",
          "refreshToken": "<string>",
          "error": "<string>",
          "expiresIn": 123,
          "expiresAt": "<string>",
          "authedUserId": "<string>",
          "botUserId": "<string>",
          "teamId": "<string>",
          "teamName": "<string>",
          "teamDomain": "<string>",
          "channelName": "<string>",
          "channelId": "<string>",
          "teamUrl": "<string>",
          "organizationId": "<string>",
          "enterpriseId": "<string>",
          "enterpriseName": "<string>",
          "isEnterpriseInstall": true,
          "workflowsAppId": "<string>",
          "workflowsAppSigningSecret": "<string>",
          "agentWorkspaceId": "<string>",
          "configSettings": "<any>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      }
    ],
    "activePersonality": {
      "id": "<string>",
      "workspaceId": "<string>",
      "persona": "<string>",
      "tone": "<string>",
      "emoji": "<string>",
      "length": "<string>",
      "greeting": "<string>",
      "branding": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    },
    "settings": {
      "id": "<string>",
      "ticketAssigneeScope": "<string>",
      "disableSlackUserSync": true
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
]

Authorizations

​
x-ravenna-api-token
string
header
required

Response

Successful response

​
id
string
required
​
name
string
required
​
slug
string
required
​
organizationId
string
required
​
creatorId
string
required
​
private
boolean
required
​
slackBotIconUrl
string | null
required
​
slackBotUsername
string | null
required
​
slackEmojiActions
any
required
​
brandIcon
string | null
required
​
brandColor
string | null
required
​
defaultQueueId
string | null
required
​
slackTriageChannels
object[]
required
​
activePersonality
object | null
required
​
settings
object | null
required
​
createdAt
string
required
​
updatedAt
string
required
​
deletedAt
string | null
required
⌘I