Skip to main content
POST
/
v2
/
exports
Request Export
curl --request POST \
  --url https://api.example.com/v2/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "export_type": "invoice",
  "filters": {}
}
'
{
  "export": {
    "id": "<string>",
    "export_type": "invoice",
    "status": "pending",
    "filters": {},
    "record_count": 123,
    "download_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "requested_by": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>"
    }
  },
  "was_existing": false
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to create a new export.

export_type
enum<string>
required

Type of data to export

Available options:
invoice,
partner,
payment,
analytics
filters
object

Optional filter criteria for the export

Response

Successful Response

Response from creating or deduplicating an export.

export
object
required

Response containing export details.

was_existing
boolean
default:false
required

True if an existing pending export was returned instead of creating new