Pagination

All public v1 list endpoints return a shared envelope:

{
  "data": [ /* resources for this page */ ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 123,
    "hasMore": true
  }
}

Query parameters

Validated by Zod (publicPaginationQuerySchema in lib/openapi/public-v1-schemas.ts):

Name	Type	Default	Constraints
`limit`	integer (query string digits)	`50`	1–100
`offset`	integer (query string digits)	`0`	≥ 0

Invalid values (non-numeric, out of range) → 400 with Zod details.

Algorithm

offset = 0
limit  = 50
loop:
  GET …?limit=50&offset={offset}
  process data[]
  if not pagination.hasMore: stop
  offset = offset + limit

bash loop

OFFSET=0
LIMIT=50
BASE="https://cicini.com/api/public/v1/customers"

while true; do
  RESP=$(curl -sS -H "Authorization: Bearer $CICINI_API_KEY" \
    "$BASE?limit=$LIMIT&offset=$OFFSET")
  echo "$RESP" | jq '.data | length'
  HAS_MORE=$(echo "$RESP" | jq -r '.pagination.hasMore')
  [ "$HAS_MORE" = "true" ] || break
  OFFSET=$((OFFSET + LIMIT))
done

Ordering

Endpoint	Default order
Customers	`createdAt` descending
Appointments	`startAt` descending

There is no public cursor/page param today — use offset only.

Tips

Prefer smaller pages (25–50) for large orgs to keep payloads small.
total is the full filtered count, not just the page size.
Concurrent writes can change total between pages; design sync jobs to be idempotent on resource id.

Get started

Core resources

Examples

Pagination

Query parameters

Algorithm

bash loop

Ordering

Tips

​Pagination

​Query parameters

​Algorithm

​bash loop

​Ordering

​Tips

Pagination

Query parameters

Algorithm

bash loop

Ordering

Tips