Private
List bundles
Returns a list of all bundles available.
get/bundles
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
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"
}
]
}