Skip to main content

​
Overview

PaginationInfo describes the current page, the total number of results, and whether more pages are available. Every paginated endpoint returns this same shape inside its data object — for example data.pagination on photo and search responses, and data.pagination on the download response.

​
PaginationInfo

{
  "total": 47,
  "currentPage": 1,
  "totalPages": 2,
  "hasNextPage": true,
  "hasPreviousPage": false,
  "page_size": 30
}
FieldTypeDescription
totalnumberTotal items available for the request.
currentPagenumberCurrent page number.
totalPagesnumberTotal number of pages available.
hasNextPagebooleanWhether another page exists after this page.
hasPreviousPagebooleanWhether a page exists before this page.
page_sizenumberPage size used for this response.
Some empty-result responses return currentPage: 0 and totalPages: 0. Treat those values as “no page is available” rather than as a normal page number.

​
Endpoint Page Sizes

EndpointDefault page_sizeMaximum page_size
GET /api/v1/ext/{org_id}/events10100
GET /api/v1/ext/{org_id}/event/{event_id}/images32100
GET /api/v1/ext/{org_id}/event/{event_id}/bibs/{bib}32100
POST /api/v1/ext/{org_id}/event/{event_id}/faces32100
GET /api/v1/ext/{org_id}/event/{event_id}/faces/{request_id}32100
POST /api/v1/ext/{org_id}/event/{event_id}/original-photos3060

​
Used By

List Events

data.pagination field.

All Photos

data.pagination field.

BIB Search

data.pagination field.

Face Search

data.pagination field.

Download Originals

data.pagination field.