Create Async Export

Queues a CSV export job and returns it in `pending` status. Poll `GET /exports/async/{exportId}` until `status` is `completed`, then fetch the file with `GET /exports/async/{exportId}/sign` (pre-signed URL) or `GET /exports/async/{exportId}/download` (stream). This is the only non-GET operation available to read-only Apps: it requires the `read` scope, not `write`.

Authorization

appToken read

AuthorizationBearer <token>

App access token issued by POST /tokens (client credentials). Full-access Apps hold the read and write scopes, read-only Apps hold read only. Send it as Authorization: Bearer <token>.

In: header

Scope: read

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

external_user_id*string

Identifier of the user the export is created for. Used to list that user's exports later

category*string

Export category

Value in

"trades"
"payments"
"groups"

type*string

Export type

Value in

"trades"
"trades_by_client"
"trades_by_partner"
"trades_by_account"
"trades_by_role"
"payments"
"payments_by_partner"
"payments_by_program"
"groups"

filter?

Filters of the corresponding list endpoint, e.g. {"tradeStartDate": "2026-01-01"} for trades

sortBy?string

Sort column of the corresponding list endpoint

sort_order?string

Sort direction

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X POST "https://example.com/exports/async" \  -H "Content-Type: application/json" \  -d '{    "external_user_id": "string",    "category": "trades",    "type": "trades"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "external_user_id": "string",  "category": "trades",  "type": "trades",  "status": "pending",  "query": {},  "total_records": 0,  "sneak_peak": [    [      null    ]  ],  "error_message": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}

{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}

{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}

{  "message": "string",  "code": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "details": [    {      "field": "string",      "issue": "string"    }  ]}

Create Async Export

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`