Skip to main content
GET
List booking form fields

Authorizations

Authorization
string
header
required

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

Query Parameters

page[size]
number | null

The number of entries to return per page. Range between 1 - 500, defaults to 100

Required range: 1 <= x <= 500
Example:

100

page[after]
string | null

Accepts an existing page cursor. For more details see the definition of PageCursor in the response.

page[before]
string | null

Accepts an existing page cursor. For more details see the definition of PageCursor in the response.

Response

200 - application/json

Default Response

When requesting a list of booking form fields, the response will be paginated. The data field will contain an array of BookingFormFieldSummary objects, and the page field will contain a PageCursor object detailing the current page and cursors to navigate to earlier or later pages.

data
BookingFormFieldSummary · object[]
required
page
PageCursor · object
required

Cursor details for pagination.

  • In scenarios with large amounts of data, it's common to return only a subset of data in a single request, known as a "page".
  • Most API responses include two objects: a 'data' object with the query results, and a 'PageCursor' object detailing the current page.
  • Cursors can be used to navigate to earlier or later pages in the set of results. For instance, passing the 'next' cursor from 'PageCursor' fetches the next set of results.
  • Cursors are base64 encoded strings.
Example: