Skip to content
Emissary Developer Documentation

Idempotency and pagination

Idempotency

Section titled “Idempotency”

The OpenAPI contract declares support and requiredness for each operation that accepts an Idempotency-Key. Reuse the same key only for the same logical request. A changed payload with a reused key conflicts; an in-progress operation may return a conflict rather than duplicate work.

POST /v1/environments/{environmentId}/invoices
Authorization: Bearer <environment-api-key>
Idempotency-Key: <stable-operation-key>
Content-Type: application/json

No blind retries

Idempotency does not make an ambiguous external submission safe to repeat unless that specific endpoint guarantees it. Do not automatically retry issue/submission mutations after uncertain outcomes.

Cursor pagination

Section titled “Cursor pagination”

List endpoints may use a limit and continuation cursor. Pass the returned cursor as the next page’s after value without modifying it. Apply the same tenant and filter context for the whole traversal, and stop when no continuation cursor is returned.