--- title: "List Exports" method: GET path: "/v1/exports" tags: ["Exports"] --- # List Exports `GET /v1/exports` List all exports. ## Query parameters - `limit` integer - `page` integer - `order` 'created_at' | '-created_at' | 'status' | '-status' ## Response `200` 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`. - ExportsListResponseBody — Response body schema for **GET** `v1/exports`. - `object` 'list', required — The type of the object represented by JSON. This object stores information about exports. - `data_ref` 'exports', required — Identifies the name of the attribute that contains the array of exports. - `exports` Export[], required — An array of export objects. - union - ExportVoucher - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'voucher', required — The type of object to be exported. - `parameters` object - `order` '-created_at' | 'created_at' | '-updated_at' | 'updated_at' | '-code' | 'code' - `fields` ExportVoucherFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportVoucherFilters — Allowed additional properties must start with "metadata." or "redemption." - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` FieldConditions - … - `updated_at` FieldConditions - … - `created_date` FieldConditions - … - `active` FieldConditions - … - `redemption_status` FieldConditions - … - `start_date` FieldConditions - … - `expiration_date` FieldConditions - … - `validity_day_of_week` FieldConditions - … - `code` FieldConditions - … - `categories` FieldConditions - … - `vouchers` FieldConditions - … - `holder_id` FieldConditions - … - `is_referral_code` FieldConditions - … - `published_for_customer_id` FieldConditions - … - `validity_timeframe` FieldConditions - … - `category_ids` FieldConditions - … - `campaign_id` string — Unique identifier of the campaign. It is assigned by Voucherify. The campaign ID defines the campaign for which the voucher export will be triggered. - ExportRedemption - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'redemption', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-id' | 'id' | '-voucher_code' | 'voucher_code' | '-tracking_id' | 'tracking_id' | '-customer_id' | 'customer_id' | '-created_at' | 'created_at' - `fields` ExportRedemptionFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportRedemptionFilters — Allowed additional properties must start with "metadata." - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` object - … - `campaign` object - … - `customer` object - … - `voucher` object - … - `related_object` object - … - `voucher_code` FieldConditions - … - `related_object_id` FieldConditions - … - `related_object_parent_id` FieldConditions - … - `parent_redemption_id` FieldConditions - … - `failure_code` FieldConditions - … - `result` FieldConditions - … - `object` FieldConditions - … - `customer_id` FieldConditions - … - `campaign_name` FieldConditions - … - `user_login` FieldConditions - … - `status` FieldConditions - … - ExportCustomer - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'customer', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-name' | 'name' | '-id' | 'id' | '-email' | 'email' | '-source_id' | 'source_id' | '-created_at' | 'created_at' | '-updated_at' | 'updated_at' - `fields` ExportCustomerFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportCustomerFilters — Allowed additional properties must start with "metadata." or "address." or "summary." or "loyalty." or "loyalty_tier." or "loyalty_points." or "system_metadata." - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` object - … - `updated_at` object - … - `email` FieldConditions - … - `name` FieldConditions - … - `city` object - … - `phone` FieldConditions - … - `birthday` FieldConditions - … - `source_id` FieldConditions - … - `publications.created_at` FieldConditions - … - `publications.related_object_id` FieldConditions - … - ExportPublication - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'publication', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-id' | 'id' | '-voucher_code' | 'voucher_code' | '-tracking_id' | 'tracking_id' | '-customer_id' | 'customer_id' | '-created_at' | 'created_at' | '-channel' | 'channel' - `fields` ExportPublicationFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportPublicationFilters — Allowed additional properties must start with "metadata." - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` object - … - `campaign` object - … - `customer` object - … - `voucher` object - … - `failure_code` FieldConditions - … - `result` FieldConditions - … - `customer_id` FieldConditions - … - `campaign_name` FieldConditions - … - `voucher_type` FieldConditions - … - `is_referral_code` FieldConditions - … - `parent_object_id` FieldConditions - … - `related_object_id` FieldConditions - … - `source_id` FieldConditions - … - ExportOrder - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'order', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-created_at' | 'created_at' | '-updated_at' | 'updated_at' | '-status' | 'status' - `fields` ExportOrderFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportOrderFilters — Allowed additional properties must start with "metadata." - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` object - … - `updated_at` object - … - `status` FieldConditions - … - `source_id` FieldConditions - … - `amount` FieldConditions - … - `total_amount` FieldConditions - … - `discount_amount` FieldConditions - … - `total_discount_amount` FieldConditions - … - `items_discount_amount` FieldConditions - … - ExportPointsExpiration - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'points_expiration', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-expires_at' | 'expires_at' - `fields` ExportPointsExpirationFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportPointsExpirationFilters - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `campaign_id` FieldConditions - … - `voucher_id` FieldConditions - … - ExportVoucherTransactions - `id` string, required — Unique export ID. - `object` 'export', required — The type of object being represented. This object stores information about the export. - `created_at` string, date-time, required — Timestamp representing the date and time when the export was scheduled in ISO 8601 format. - `status` 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR', 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. - `channel` string — The channel through which the export was triggered. - `result` object, nullable, required — Contains the URL of the CSV file. - `url` string, required — URL of the CSV file location. It contains the token used for authorization in the Download export method. - `user_id` string, nullable, required — Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE. - `exported_object` 'voucher_transactions', required — The type of object to be exported. - `parameters` object — List of available fields and filters that can be exported with an order along with the sorting order of the returned data. - `order` '-created_at' | 'created_at' - `fields` ExportVoucherTransactionsFields[] — Array of strings containing the data in the export. These fields define the headers in the CSV file. - `filters` ExportVoucherTransactionsFilters - `junction` 'and' | 'or' — Logical Operator Between Filters. Filter by conditions set on the `junction` parameter indicating how the `conditions` should be accounted for in the query. An `AND` is an all-inclusive logical operator, meaning the `AND` operator displays a record if **ALL** the conditions separated by AND are TRUE, while an `OR` operator displays a record if **ANY** of the conditions separated by OR is TRUE. - `created_at` FieldConditions - … - `voucher_id` FieldConditions - … - `campaign_id` FieldConditions - … - `total` integer, required — Total number of exports. --- [API](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions.md) · [All operations](https://skmtc.net/voucherifyio/apis/voucherify-api-async-actions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voucherifyio/voucherify-api-async-actions/revisions/4982266e0494/schema)