Skip to main content
Collection endpoints return paginated results using offset pagination. Pass page and limit as query parameters.
Bash
curl -X GET 'https://api.cadanapay.com/v1/persons?page=1&limit=20' \
  -H 'Authorization: Bearer YOUR_API_KEY'

​
Request Parameters

ParameterTypeDefaultDescription
pageinteger1Page number to retrieve (starts at 1)
limitinteger20Items per page (1–100)

​
Response Format

All list endpoints return a data array and a meta object:
JSON
{
  "data": [
    { "id": "7dd569f9-bd54-4fbb-a5c2-f0aaadc68adf", "..." : "..." },
    { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "..." : "..." }
  ],
  "meta": {
    "limit": 20,
    "currentPage": 1,
    "itemCount": 45,
    "pages": 3,
    "skipped": 0
  }
}

​
Meta Fields

FieldTypeDescription
limitnumberItems per page (from request, default 20)
currentPagenumberCurrent page number
itemCountnumberTotal items across all pages
pagesnumberTotal number of pages
skippednumberNumber of records skipped to reach the current page