Skip to main content
GET
/
user-groups
Get user groups with integration source metadata
curl --request GET \
  --url https://core.ravenna.ai/api/user-groups \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "emoji": "<string>",
      "icon": "<string>",
      "color": "<string>",
      "imageUrl": "<string>",
      "organizationId": "<string>",
      "integrationGroupId": "<string>",
      "_count": {
        "users": 123
      },
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "integrationSource": "CODA",
      "isImmutable": true
    }
  ],
  "nextCursor": "<string>",
  "totalCount": 123
}

Authorizations

​
x-ravenna-api-token
string
header
required

Query Parameters

​
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
​
workspaceId
string
​
search
string | null

Response

Successful response

​
items
object[]
required
​
totalCount
number
required
​
nextCursor
string
⌘I