Get Export

Retrieves the URL of the downloadable file, which was generated via the Create Export method.

GET /v1/exports/{exportId}

Get Export

cURL

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/exports/{exportId} \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "exp_CGnCVltmWjI9V1pGlnunw2Nf",
  "object": "export",
  "created_at": "2022-01-13T09:03:18.293Z",
  "status": "DONE",
  "channel": "API",
  "exported_object": "customer",
  "parameters": {
    "order": "",
    "fields": [
      "name",
      "id",
      "email",
      "source_id",
      "created_at"
    ],
    "filters": {
      "junction": "and"
    },
    "response_format": "CSV"
  },
  "result": {
    "url": "{{internalVoucherifyURL}}"
  },
  "user_id": null
}

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

exportId · string · required

Unique export object ID of previously created export. This object can be a: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.

Example:

"exp_2bYLdY2lQ2886wmYIHyeBWUZ"

Response

200

application/json

Returns the export object if a valid identifier was provided in the path.

Export Voucher

Export Redemption

Export Customers

Export Publication

Export Orders

Export Points Expiration

Export Vouchers Transactions

Response body schema for GET v1/exports/{exportId}.

id · string · required

Unique export ID.

object · enum<string> · default: export · required

The type of object being represented. This object stores information about the export.

Available options: export

created_at · string<date-time> · required

Timestamp representing the date and time when the export was scheduled in ISO 8601 format.

status · enum<string> · required

Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.

Available options: SCHEDULED, IN_PROGRESS, DONE, ERROR

result · object · required

Contains the URL of the CSV file.

Show child attributes

user_id · string | null · required

Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.

exported_object · enum<string> · default: voucher · required

The type of object to be exported.

Available options: voucher

channel · string

The channel through which the export was triggered.

parameters · object

Show child attributes