GET
/
user-groups
/
with-workspaces
Get user groups with workspace assignments (for organization-level management)
curl --request GET \
  --url https://core.ravenna.ai/api/user-groups/with-workspaces \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "emoji": "<string>",
      "icon": "<string>",
      "color": "<string>",
      "organizationId": "<string>",
      "users": [
        {
          "id": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "image": "<string>",
          "emailVerified": "<string>",
          "defaultWorkspaceId": "<string>",
          "isGuestCreated": true,
          "isBot": true,
          "createdAt": "<string>",
          "auth0Id": "<string>",
          "updatedAt": "<string>",
          "slackUsers": [
            {
              "id": "<string>",
              "slackUserId": "<string>",
              "slackTeamId": "<string>",
              "slackAppId": "<string>",
              "slackImageUrl": "<string>",
              "slackRealName": "<string>",
              "isBot": true,
              "createdAt": "<string>",
              "updatedAt": "<string>",
              "slackApp": {
                "appId": "<string>"
              }
            }
          ]
        }
      ],
      "workspaces": [
        {
          "id": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "color": "<string>"
        }
      ],
      "_count": {
        "users": 123,
        "workspaces": 123
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "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

Response

200
application/json

Successful response

The response is of type object.