Groups

List all group members

List and filter all the members in a group.

post/groups.memberships

Request body

offsetnumber

limitnumber

idstring required

Group id

querystring

Filter memberships by user names

Example request

{
  "limit": 25,
  "id": "a32c2ee6-fbde-4654-841b-0eabdc71b812",
  "query": "jenny"
}

Response

Example response

{
  "data": {
    "users": [
      {
        "name": "Jane Doe"
      }
    ],
    "groupMemberships": [
      {
        "user": {
          "name": "Jane Doe"
        }
      }
    ]
  },
  "pagination": {
    "limit": 25
  }
}

Changes

Changed in 2 of the 6 revisions of this API.10

Oct 18, 2024fdf2ec9c9df41See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Jul 6, 20247b33b538cd7d9See the full diff
- ○
  added the optional property data to the response with the 400 status
  response-optional-property-added
- ○
  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 400 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 400 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

Full history