Navigation
Pagination

Intro

The Big Tickets API uses cursor-based pagination for all API requests that support bulk fetches. The paginated fields use a common structure for GETting a list of items. Two query parameters are used to return the paginated results; start_on_page, and limit.

The max and default value for the limit parameter is 1000 unless otherwise specified. The minimum value is 1.

Query Parameters
  • limit (optional)
    The limit query param is used to limit the number of items to return with the request. The default is 1000 when not specified with a min value of 1 and max value of 1000.
  • start_on_page (optional)
    The start_on_page is used to return a specific page of items contained in the dataset. Typically the start_on_page would be set as the previous start_on_page value with an incriment of one (e.g. next_page_starts_on). If the query parameter is not included, the call will return the first page of items in the dataset.
Response format
  • items (array)
    This will be the array of items returned as a response to the HTTP request. Each item will contain an unique id of type string for each of the individual items (e.g. events). The max number of items returned will be based on the query parameter limit.
  • previous_page_starts_on (string)
    This value represents the page of items previous to the current page. It will not be present for the first page of the dateaset.
  • next_page_starts_on (string)
    This value represents the page of items after the current page. It will not be present if there are no additional pages in the dataset (i.e. you are viewing the final or only page of the dataset).
Response Body
{
	"previous_page_starts_on": 1,
	"next_page_starts_on": 3,
	"items": []
}