Errors and pagination
Response envelope, request IDs, limits, and offset pagination.
Errors use the same flat JSON shape across these methods:
{
"code": "not_found",
"message": "Incident not found",
"request_id": "example-request-id",
"details": null
}Every response includes X-Request-ID. Share that value when investigating a failed request. Error codes and messages may vary by cause; use the HTTP status for program logic.
| Status | Meaning |
|---|---|
401 | Missing, invalid, expired, or revoked key; or the key owner no longer has workspace access. |
403 | Valid key without incidents:read. |
404 | Incident does not exist in the key's workspace. |
422 | Invalid path or query parameter. |
429 | Rate limit exceeded. Use the Retry-After header before retrying. |
GET /api/v1/incidents uses limit and offset. limit defaults to 50 and accepts 1–200; offset defaults to 0. The response is { "items": [...] } with no total count or next cursor. To read subsequent pages, increase offset by the number of items received until a page is shorter than limit. If incidents are added while paging, offset pagination can repeat or skip entries.