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

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 100
​
include_all_org
boolean
default:false

If true (and user is admin), show all organization exports

​
user_id
string | null

Filter exports by the user who requested them (admin only)

​
created_after
string<date-time> | null

Filter exports created on or after this date

​
created_before
string<date-time> | null

Filter exports created on or before this date

Response

Successful Response

Response containing a list of exports.

​
exports
ExportResponse · object[]
required