PSpscrpt
data-transfer

Export a resource to a file

Changed on

Starts an async job that writes every record of a resource matching filters to one file. See Bulk exports.

post/exports

Request

  • Base URL
    https://api.pscrpt.com/v1
  • URL
    https://api.pscrpt.com/v1/exports
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.pscrpt.com/oauth/authorize
      Token URL: https://api.pscrpt.com/oauth/token

Headers

Idempotency-Keystring

Deduplicates retries for 24 hours: the same key returns the original response with Idempotency-Replayed: true; the same key with a different body returns 409 idempotency_key_reused.

Postscript-Versionstring date
Example:2026-07-23

Overrides the key's pinned API revision for this request.

Request body

filtersobject

The resource's list filters as an object, such as {"type": {"in": ["order.completed"]}}; a bare value means eq. Events exports need occurred_at with gte and lt, any number of days apart.

format'jsonl' | 'csv'
resourcestring required

The resource the rows belong to, such as profiles.

Example request

{
  "resource": "profiles"
}

Response

Export accepted.

Example response

{
  "data": {
    "completed_at": "2026-07-23T17:32:01.123456Z",
    "created_at": "2026-07-23T17:32:01.123456Z",
    "resource": "profiles"
  }
}

Changes