TeamGriddeveloper
TeamGrid Developer

Pagination and idempotency

Traverse stable cursor pages and make safe retriable creates with TeamGrid API v1.

Cursor pagination

List operations accept a bounded limit and an optional opaque cursor.

GET /v1/tasks?limit=50
GET /v1/tasks?limit=50&cursor=<nextCursor>

Read the next cursor from meta.page.nextCursor. A value of null means that the result is complete.

Do not decode, edit, sort, or persist assumptions about the cursor format. Restart a traversal without a cursor when the filter set changes.

Idempotent creates

Creates and asynchronous domain commands that can be safely replayed require an Idempotency-Key header. This includes project templates, their instantiation, project lifecycle operations, and planned-work replacement:

Idempotency-Key: sync-job-2026-07-19-task-42

The key must contain 1–128 printable ASCII characters. Repeating the same operation with the same key and payload returns the original result. Reusing the key with a different payload returns a conflict.

For project lifecycle actions and project-template instantiation, a retry must use the same key, action, payload, and source revision. Every start request also requires the latest strong ETag through If-Match.

Generate keys from a stable operation identity rather than a random value created on every retry. Keep keys free of credentials and personal data.

GET requests and idempotent POST requests can be retried after bounded transient failures. A planned-work PUT is retryable only with both its idempotency key and strong compare-and-set precondition. Other PUT, PATCH, and DELETE requests should not be retried automatically unless the caller has separately established their outcome.

See resource concurrency for the distinction between the 17 core CAS mutations and the 31 domain-specific protected operations.

Stable documentation · Developer Platform · Reviewed 2026-07-29Edit this page ↗
Documentation feedbackWas this page useful?
Esc

Search TeamGrid Developer

Find guides, concepts and every API operation.