Skip to main content
GET
/
v1
/
exports
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/exports/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "328abc47-c3da-476c-86b2-a6c7f2187e7e",
  "object": "export_customer",
  "email": "[email protected]",
  "file_url": null,
  "record_count": 0,
  "status": "pending",
  "type": "customers",
  "created_at": 1767909700,
  "updated_at": 1767909700
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
type
string

The type of export – one of charges, coupons, customers, orders, prices, promotions, refunds, subscriptions.

​
email
string

The email where the export will be sent.

​
file_url
string | null

The URL for accessing the export file.

​
status
string

The status of the export – one of pending, processed, or sent.

​
record_count
number

The number of records that were exported.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.