GET
/
user-groups
/
{id}
/
users
Get a user group with users
curl --request GET \
  --url https://core.api.ravenna.ai/api/user-groups/{id}/users \
  --header 'x-ravenna-api-token: <api-key>'
{
  "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>",
      "slackTeamId": "<string>",
      "slackUserId": "<string>",
      "slackRealName": "<string>",
      "slackImageUrl": "<string>",
      "emailVerified": "<string>",
      "defaultWorkspaceId": "<string>",
      "isGuestCreated": true,
      "isBot": true,
      "createdAt": "<string>",
      "auth0Id": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "_count": {
    "users": 123
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Path Parameters

id
string
required

Query Parameters

sortBy
enum<string>
Available options:
user,
email,
createdAt
sortDirection
enum<string>
Available options:
asc,
desc

Response

200
application/json

Successful response

The response is of type object.