Skip to main content
GET
/
bundles
Get bundles
curl --request GET \
  --url https://api.opal.dev/v1/bundles \
  --header 'Authorization: Bearer <token>'
{
  "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
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page_size
integer

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

​
cursor
string

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

​
contains
string

A filter for the bundle name.

Response

200 - application/json

A list of bundles for your organization.

​
bundles
object[]
required
​
previous
string | null

The cursor used to obtain the current result page.

Example:

"cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ"

​
next
string | null

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

Example:

"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"

​
total_count
integer

The total number of items in the result set.

Example:

2