Skip to content

Pagination

limit / offset

Every paginated endpoint accepts limit and offset:

GET /v1/jobs/{id}/results?limit=200&offset=400

Response:

{
"data": [...],
"meta": {
"count": 200,
"total": 8541,
"limit": 200,
"offset": 400,
"has_more": true
},
"request_id": "..."
}

Stop when has_more is false.

Caps

EndpointDefaultMax
/v1/jobs/{id}/results1001000
/v1/usage1001000
/v1/jobs50500
/v1/webhooks/{id}/deliveries50200

CSV / NDJSON output

For programmatic ingestion of large result sets, use ?format=ndjson and stream the response:

const res = await fetch(`${api}/v1/jobs/${id}/results?format=ndjson&limit=1000`, {
headers: { authorization: `Bearer ${key}` }
});
const reader = res.body!.getReader();
// ... newline-delimited JSON parsing

CSV (?format=csv) flattens nested fields with dot-notation column names (address.streetAddress, latLong.latitude). Arrays are JSON-stringified in their cell.