List Exports

List all exports.

GET /v1/exports

List Exports

cURL

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

200

{
  "object": "list",
  "data_ref": "exports",
  "exports": [
    {
      "id": "exp_323UOPsH42twhJVaDZXf4UNo",
      "object": "export",
      "created_at": "2022-08-04T09:11:25.208Z",
      "status": "DONE",
      "channel": "API",
      "exported_object": "order",
      "parameters": {
        "order": "-created_at",
        "fields": [
          "id",
          "source_id",
          "status"
        ],
        "filters": {
          "junction": "and"
        }
      },
      "result": {
        "url": "{{internalVoucherifyURL}}"
      },
      "user_id": null
    },
    {
      "id": "exp_sPQR0na2gU0pIVUKIz4wdQI9",
      "object": "export",
      "created_at": "2022-05-02T06:44:03.186Z",
      "status": "DONE",
      "channel": "API",
      "exported_object": "voucher",
      "parameters": {
        "order": "-created_at",
        "fields": [
          "id",
          "code",
          "voucher_type",
          "value"
        ],
        "filters": {
          "junction": "and"
        }
      },
      "result": {
        "url": "{{internalVoucherifyURL}}"
      },
      "user_id": null
    },
    {
      "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
    }
  ],
  "total": 3
}

Authorizations

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

X-App-Id · string · header · required

X-App-Token · string · header · required

Query Parameters

limit · integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items.

Required range: 1 <= x <= 100

page · integer

Which page of results to return. The lowest value is 1.

Required range: 1 <= x <= 100

order · enum<string>

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

Available options: created_at, -created_at, status, -status

Response

200 - application/json

A dictionary with an exports property that contains an array of exports. Each entry in the array is a separate export object. The list will return the following types of exported objects: voucher, redemption, publication, customer, order, points_expiration, or voucher_transactions.

The channel parameter in the response body returns the channel that was used to generate the particular export. The user_id identifies the specific user who initiated the export through the Voucherify Dashboard; this user_id is returned when the channel value is WEBSITE.

Response body schema for GET v1/exports.

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

The type of the object represented by JSON. This object stores information about exports.

Available options: list

data_ref · enum<string> · default: exports · required

Identifies the name of the attribute that contains the array of exports.

Available options: exports

exports · (Export Voucher · object | Export Redemption · object | Export Customers · object | Export Publication · object | Export Orders · object | Export Points Expiration · object | Export Vouchers Transactions · object)[] · required

An array of export objects.

Export Voucher

Export Redemption

Export Customers

Export Publication

Export Orders

Export Points Expiration

Export Vouchers Transactions

Show child attributes

total · integer · required

Total number of exports.