Skip to main content
POST
Queue an async export of the tenant's data

Authorizations

Authorization
string
header
required

Same flow; ledger:write is required for any mutation.

Headers

Idempotency-Key
string

Required on writes. Stable identifier you choose. The same key always returns the same transaction, forever. Can also be supplied as idempotency_key in the request body. Header wins.

Allowed character set: A-Z, a-z, 0-9, _, :, ., -. Max 255 bytes. Replays of an accepted key return the original response with header Idempotent-Replayed: true so callers can tell a replay from a freshly-committed result.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_:.\-]+$
Example:

"pi_acme_1234_capture"

Body

application/json
resources
enum<string>[]

Defaults to all known resources when omitted.

Available options:
accounts,
transactions,
postings,
events,
period_closes,
reconciliation_runs,
webhook_endpoints
format
enum<string>
default:ndjson
Available options:
ndjson

Response

Idempotency-Key replay.

data
object