OPopal
groups

GET /groups/{group_id}/users

Changed on

Gets the list of users for this group.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Path parameters

group_idstring uuid required

The ID of the group.

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page, up to 1000. When set (or when a cursor is provided), the response contains a single page of results and a next cursor; the default page size is 200. When both page_size and cursor are omitted, the entire group membership is returned in one response with no next cursor. For large groups, prefer setting page_size and following next.

Response

List of users with access to this group.

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"
    }
  ]
}

Changes

  • 1f15df5de3bcRevision changes
    • warning

      added the new ERR_CONNECTION_VALIDATION_FAILED enum value to the /// response property for the response status

  • 327ea741c867Revision changes
    • warning

      added the new ERR_REMOTE_TICKET_NOT_FOUND enum value to the /// response property for the response status