Pagination and queries

How Pallyy API list endpoints paginate with page and size parameters, and how to pass nested filters and sorting in the query string.

List endpoints share the same pagination parameters and response envelope, and accept nested filter and sort objects encoded with bracket syntax.

Pagination parameters

ParameterDefaultMeaning
page0Zero-based page index
size25Items per page, between 1 and 100

Paginated responses wrap their results in a common envelope:

{
  "items": [],
  "page": 0,
  "size": 25
}

Nested query objects

Filters and sorting are objects, encoded in the query string with bracket syntax. Arrays use empty brackets:

curl "https://app.pallyy.com/api/v1/post-sets?socialSetId=SET_ID&size=10&filters[status][]=SCHEDULED&sort[scheduledAt]=DESC" \
  -H "Authorization: Bearer pallyy_your_api_key"

Sort values are ASC or DESC. Boolean filter values are passed as the strings true or false.

Each endpoint's page documents the filters and sort fields it supports. Unknown filter or sort fields are rejected with a 400.

View as markdown

More in Getting started

Questions about the API? Email us at hey@pallyy.com and we'll get back to you.