Skip to Content
Welcome to Festie! 🎪 The ultimate festival management platform is here!
Response Shapes

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

NameTypeDefaultNotes
pageinteger1Starts at 1.
limitinteger20Maximum 500.
sortBystringendpoint defaultUnsupported sort fields fall back to the endpoint default.
sortOrderasc or descendpoint defaultUsed 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-2

Boolean array filters accept true, false, 1, 0, yes, and no.

Last updated on