Skip to main content
GET
/
user-groups
/
{id}
/
users
Get a user group with users
curl --request GET \
  --url https://core.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>",
  "imageUrl": "<string>",
  "organizationId": "<string>",
  "integrationGroupId": "<string>",
  "_count": {
    "users": 123
  },
  "createdAt": "<string>",
  "updatedAt": "<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>",
          "slackDisplayName": "<string>",
          "isBot": true,
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "slackApp": {
            "appId": "<string>"
          }
        }
      ]
    }
  ],
  "integrationSource": "CODA",
  "isImmutable": true
}

Authorizations

​
x-ravenna-api-token
string
header
required

Path Parameters

​
id
string
required

Query Parameters

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

Response

Successful response

​
id
string
required
​
name
string
required
​
description
string | null
required
​
imageUrl
string | null
required
​
organizationId
string
required
​
integrationGroupId
string | null
required
​
createdAt
string
required
​
updatedAt
string
required
​
users
object[]
required
​
integrationSource
enum<string> | null
required
Available options:
CODA,
CONFLUENCE,
NOTION,
SLACK,
GOOGLE_DRIVE,
ONE_NOTE,
CLICK_UP,
RAVENNA,
OKTA,
GOOGLE_WORKSPACE,
INCIDENT_IO,
FLEET_DM,
LINEAR,
JIRA,
JSM,
GITHUB,
STATIC_WEBPAGE
​
isImmutable
boolean
required
​
emoji
string | null
​
icon
string | null
​
color
string | null
​
_count
object
⌘I