Pagination Model

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
}

Field	Type	Description
`total`	number	Total items available for the request.
`currentPage`	number	Current page number.
`totalPages`	number	Total number of pages available.
`hasNextPage`	boolean	Whether another page exists after this page.
`hasPreviousPage`	boolean	Whether a page exists before this page.
`page_size`	number	Page 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

Endpoint	Default `page_size`	Maximum `page_size`
`GET /api/v1/ext/{org_id}/events`	`10`	`100`
`GET /api/v1/ext/{org_id}/event/{event_id}/images`	`32`	`100`
`GET /api/v1/ext/{org_id}/event/{event_id}/bibs/{bib}`	`32`	`100`
`POST /api/v1/ext/{org_id}/event/{event_id}/faces`	`32`	`100`
`GET /api/v1/ext/{org_id}/event/{event_id}/faces/{request_id}`	`32`	`100`
`POST /api/v1/ext/{org_id}/event/{event_id}/original-photos`	`30`	`60`

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.

Get Started

Events

Memories

Browse Photos

Search

Video

Downloads

Pipeline

Models

Overview

PaginationInfo

Endpoint Page Sizes

Used By

List Events

All Photos

BIB Search

Face Search

Download Originals

​Overview

​PaginationInfo

​Endpoint Page Sizes

​Used By

List Events

All Photos

BIB Search

Face Search

Download Originals

Overview

PaginationInfo

Endpoint Page Sizes

Used By