v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
groups

Returns all groups that the user is a member of.

get/groups/users/{user_id}

Path parameters

user_idstring uuid required

The ID of the user whose groups to return.

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

Response

The groups that the user is a member of.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "full_name": "Jake Barnes",
      "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-01-23T04:56:07Z",
      "email": "jake@company.dev"
    },
    {
      "full_name": "Brett Ashley",
      "user_id": "7646aa9a-e2ee-4eb5-8c62-91f29038a373",
      "group_id": "1b978423-db0a-4037-a4cf-f79c60cb67b3",
      "expiration_date": "2022-02-03T12:33:02Z",
      "email": "brett@company.dev"
    }
  ]
}