OFoffice-of-national-statistics
Private

List bundles

Changed on

Returns a list of all bundles available.

get/bundles

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Maximum number of items that will be returned. A value of zero will return zero items.

offsetinteger

Starting index of the items array that will be returned. By default it is zero, meaning that the returned items will start from the beginning.

publish_datestring date-time

Filter bundles by their scheduled publication date. Accepts an optional datetime value and returns all bundles where the scheduled_at field matches the specified datetime.

Response

A json list containing bundles

countinteger

The number of items returned.

limitinteger

The number of items requested.

offsetinteger

The offset of the first item to retrieve, starting at 0. Use this parameter as a pagination mechanism along with the limit parameter

total_countinteger

The total number of items available.

Example response

{
  "count": 20,
  "total_count": 123,
  "items": [
    {
      "bundle_type": "SCHEDULED",
      "created_by": {
        "email": "publisher@ons.gov.uk"
      },
      "created_at": "2025-04-04T07:00:00.000Z",
      "id": "9e4e3628-fc85-48cd-80ad-e005d9d283ff",
      "last_updated_by": {
        "email": "publisher@ons.gov.uk"
      },
      "preview_teams": [
        {
          "id": "1253e849-01fd-4662-bee2-63253538da93"
        }
      ],
      "scheduled_at": "2025-04-04T07:00:00.000Z",
      "state": "APPROVED",
      "title": "CPI March 2025",
      "updated_at": "2025-04-04T07:00:00.000Z",
      "managed_by": "WAGTAIL"
    }
  ]
}

Changes