3 min read

Pagination & idempotency

Page through large collections, and make writes safe to retry.

Pagination

List endpoints accept limit (1–100, default 50) and offset (default 0), and return the page plus a total count:

GET /api/v1/records?limit=50&offset=100

{
  "records": [ ... ],
  "total": 1284,
  "limit": 50,
  "offset": 100
}

The collection key matches the resource (records, assets, locations, …). Keep requesting with an increasing offset until you’ve read total items.

Idempotency

POST endpoints accept an Idempotency-Key header (use a UUID per logical operation). If the same key is seen again within 24 hours, the original response is replayed with an X-Idempotent-Replay: true header instead of creating a duplicate — so you can safely retry after a network timeout.

curl -X POST "https://app.facilityopsiq.com/api/v1/records" \
  -H "Authorization: Bearer wo_your_key_here" \
  -H "Idempotency-Key: 5f9c2e10-8a3b-4b7e-9d21-1c0a2f6b7e44" \
  -H "Content-Type: application/json" \
  -d '{ "categoryId": "cat_...", "address": "...", "requesterName": "...", "description": "..." }'

Open the API reference All guides