Response Shapes
Public REST endpoints return JSON. List endpoints use a consistent context, data, and meta shape.
The context object identifies the festival data behind the response. Treat it as response metadata, not as authentication input.
Context
Every response includes the resolved festival context.
{
"context": {
"festivalId": "uuid",
"host": "festival-public-host",
"subdomain": "festival-subdomain",
"customDomain": null,
"resolvedByCustomDomain": false
}
}List Response
{
"context": {
"festivalId": "uuid",
"host": "festival-public-host",
"subdomain": "festival-subdomain",
"customDomain": null,
"resolvedByCustomDomain": false
},
"data": [],
"meta": {
"total": 0,
"page": 1,
"limit": 20,
"totalPages": 0,
"hasNextPage": false,
"hasPrevPage": false
}
}Pagination Query
| Name | Type | Default | Notes |
|---|---|---|---|
page | integer | 1 | Starts at 1. |
limit | integer | 20 | Maximum 500. |
sortBy | string | endpoint default | Unsupported sort fields fall back to the endpoint default. |
sortOrder | asc or desc | endpoint default | Used with sortBy. |
Array Filters
Some filters accept arrays. Send them as repeated query parameters or comma-separated values:
categoryIds=uuid-1&categoryIds=uuid-2
categoryIds=uuid-1,uuid-2Boolean array filters accept true, false, 1, 0, yes, and no.
Last updated on