Skip to main content
GET
/
v2
/
exports
/
{export_id}
Get Export
curl --request GET \
  --url https://api.example.com/v2/exports/{export_id} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
export_id
string
required

Response

Successful Response

Response containing export details.

​
id
string
required
​
export_type
enum<string>
required
Available options:
invoice,
partner,
payment,
analytics
​
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed
​
filters
object
required
​
record_count
integer | null
required
​
download_url
string | null
required
​
created_at
string<date-time>
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
requested_by
ExportUserRef · object
required

Reference to the user who requested the export.