OPopal
bundles

Get bundles

Returns a list of Bundle objects.

get/bundles

Request

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

Query parameters

page_sizeinteger

The maximum number of bundles 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.

containsstring

A filter for the bundle name.

Response

A list of bundles for your organization.

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",
  "totalCount": 2,
  "bundles": [
    {
      "id": "a381e7a3-e5e0-4c48-b1d6-4ccb4c191bc1",
      "name": "Bundle 1",
      "description": "Description of bundle 1",
      "admin_owner_id": "4aed3e8a-727b-4d72-8010-3b8710c50bec",
      "total_num_items": 0,
      "total_num_resources": 0,
      "total_num_groups": 0
    },
    {
      "id": "8294e9c9-deb6-48e9-9c99-da2a1e04a87f",
      "name": "Bundle 2",
      "description": "Description of bundle 2",
      "admin_owner_id": "4aed3e8a-727b-4d72-8010-3b8710c50bec",
      "total_num_items": 0,
      "total_num_resources": 0,
      "total_num_groups": 0
    }
  ]
}

Changes

No recorded changes to this operation across all 43 revisions of this API.