Groups

List all groups

post/groups.list

Request body

offsetnumber

limitnumber

sortstring

direction'ASC' | 'DESC'

Example request

{
  "limit": 25,
  "sort": "updatedAt",
  "direction": "DESC"
}

Response

Example response

{
  "data": {
    "groups": [
      {
        "name": "Engineering",
        "memberCount": 11
      }
    ],
    "groupMemberships": [
      {
        "user": {
          "name": "Jane Doe"
        }
      }
    ]
  },
  "pagination": {
    "limit": 25
  }
}

Changes

Changed in 3 of the 6 revisions of this API.19

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d6See the full diff
- ○
  added the optional property data to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property data to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property message to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 403 status
  response-optional-property-added
Jun 12, 2024be4f4b1ba5e812See the full diff
- ▲
  the data response's property type/format changed from array/ to object/ for status 200
  response-property-type-changed
- ○
  added the optional property data/groupMemberships to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/groups to the response with the 200 status
  response-optional-property-added

Full history