Contendar Help

Pagination and filtering

Every list endpoint uses the same paging rules and the same response shape.

Response shape

A list endpoint returns the rows in a data array, with a pagination object:

{
  "data": [],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "total": 42,
    "totalPages": 2
  }
}
FieldTypeNotes
dataarrayThe rows for this page.
pagination.pagenumberThe page you asked for.
pagination.pageSizenumberThe rows per page you asked for.
pagination.totalnumberThe total number of matching rows.
pagination.totalPagesnumberThe total number of pages. Always at least 1.

Shared query parameters

ParameterTypeDefaultNotes
projectIdUUIDrequiredThe project to read.
pageinteger1The page number, starting at 1.
pageSizeinteger25Rows per page. The minimum is 1. The maximum is 100.
searchstringnoneFree text search across the main fields.

Filters

Each list has its own filters on top of the shared parameters. For example, testimonial submissions can be filtered by status, type, sentiment, minRating, formBuilderId, and customerId.

Some testimonial filters accept more than one value as a comma separated list, for example status=approved,pending.

See each list endpoint page for its full filter set.

Read every page

  1. Request page=1.
  2. Read pagination.totalPages.
  3. Request each page from 2 up to totalPages.
  4. Stop when page reaches totalPages.

Related pages

Was this helpful?