Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
bundles

Returns a list of Group objects in a given bundle.

get/bundles/{bundle_id}/groups

Path parameters

bundle_idstring uuid required

The ID of the bundle.

Query parameters

page_sizeinteger

The maximum number of groups to return from the beginning of the list. Default is 200, max is 1000.

cursorstring

A cursor indicating where to start fetching items after a specific point.

Response

A list of groups for the bundle.

previousstring nullable

The cursor used to obtain the current result page.

nextstring nullable

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

total_countinteger

The total number of items in the result set.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "total_count": 2,
  "bundle_groups": [
    {
      "id": "a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
      "name": "Group 1"
    },
    {
      "id": "8294e9c9-deb6-48e9-9c99-da2a1e04a87f",
      "name": "Group 2"
    }
  ]
}