Overview

API Guides

Pattern-focused API guides with practical examples, tradeoffs, and implementation notes.

Guides

Bulk updates via async jobs

Move heavy bulk operations out of the request/response cycle with job resources. Enqueue work, return quickly, let clients poll for status.

Use when

You need to perform large batches of writes without blocking clients or hammering your database.

Use opaque cursors instead of numeric offsets for more stable pagination over changing data like feeds, logs, or events.

Use when

You need robust pagination over changing data like feeds, logs, or events.

Avoid over-fetching by default while letting clients pull related data in one call when needed using expand parameters.

Use when

You want to avoid over-fetching by default but let clients pull related data in one call when needed.

Let clients safely retry non-idempotent calls without accidentally creating duplicates. Essential for payments and critical operations.

Use when

Clients may retry requests and you want to avoid duplicate side effects.

Push events to third-party systems in near-real-time with signed payloads, retry logic, and event replay capabilities.

Use when

Your API needs to push events to third-party systems in near-real-time.