GET
/
workspaces
curl --request GET \
  --url https://core.api.ravennahq.com/api/workspaces \
  --header 'x-ravenna-api-token: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "organizationId": "<string>",
    "creatorId": "<string>",
    "private": true,
    "color": "tomato",
    "slackBotIconUrl": "<string>",
    "slackBotUsername": "<string>",
    "defaultQueueId": "<string>",
    "slackTriageChannel": {
      "id": "<string>"
    },
    "activePersonality": {
      "id": "<string>",
      "workspaceId": "<string>",
      "tone": "<string>",
      "emoji": "<string>",
      "length": "<string>",
      "greeting": "<string>",
      "branding": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    },
    "settings": {
      "id": "<string>",
      "ticketAssigneeScope": "<string>"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>"
  }
]

Authorizations

​
x-ravenna-api-token
string
header
required

Query Parameters

​
organizationId
string
​
name
string
​
skip
number | null
Required range: x >= 1
​
offset
number | null
Required range: x >= 0
​
cursor
string | null
​
limit
number | null
default:100
Required range: 1 <= x <= 10000
​
set
string | null
​
sortBy
string | null
​
sortDirection
enum<string> | null
Available options:
asc,
desc
​
groupBy
string | null
​
groupDirection
enum<string> | null
Available options:
asc,
desc

Response

200
application/json

Successful response

The response is of type object[].