--- title: "Get Export" method: GET path: "/v1/exports/{exportId}" tags: ["Exports"] --- # Get Export `GET /v1/exports/{exportId}` Retrieves the URL of the downloadable file, which was generated via the [Create Export](/api-reference/exports/create-export) method. ## Response `200` Returns the export object if a valid identifier was provided in the path. - union — Response body schema for **GET** `v1/exports/{exportId}`. - object - `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 - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `updated_at` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `created_date` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `active` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `redemption_status` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `start_date` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `expiration_date` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `validity_day_of_week` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `code` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `categories` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `vouchers` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `holder_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `is_referral_code` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `published_for_customer_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `validity_timeframe` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `category_ids` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `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. - object - `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 - `conditions` object - `$after` union[] - … - `$before` union[] - … - `campaign` object - `conditions` object - `$is` union[] - … - `customer` object - `conditions` object - `$is` union[] - … - `voucher` object - `conditions` object - `$is` union[] - … - `related_object` object - `conditions` object - `$in` union[] - … - `voucher_code` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `related_object_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `related_object_parent_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `parent_redemption_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `failure_code` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `result` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `object` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `customer_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `campaign_name` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `user_login` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `status` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - object - `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 - `conditions` object - `$after` union[] - … - `$before` union[] - … - `updated_at` object - `conditions` object - `$after` string[] - `$before` string[] - `$is` string[] - `email` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `name` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `city` object - `conditions` object - `$is` union[] - … - `phone` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `birthday` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `source_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `publications.created_at` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - `publications.related_object_id` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - `$less_than_ago` union[] - … - `$more_than_future` union[] - … - `$less_than_future` union[] - … - `$more_than_equal` union[] - … - `$less_than_equal` union[] - … - `$after` union[] - … - `$before` union[] - … - `$count` union[] - … - `$count_less` union[] - … - `$count_more` union[] - … - object - `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 - `conditions` object - `$after` union[] - … - `$before` union[] - … - `campaign` object - `conditions` object - `$is` union[] - … - `customer` object - `conditions` object - `$is` union[] - … - `voucher` object - `conditions` object - `$is` union[] - … - `failure_code` FieldConditions - `conditions` FiltersCondition - `$in` union[] - … - `$not_in` union[] - … - `$is` union[] - … - `$is_days_ago` union[] - … - `$is_days_in_future` union[] - … - `$is_not` union[] - … - `$has_value` union[] - … - `$is_unknown` union[] - … - `$contains` union[] - … - `$not_contain` union[] - … - `$starts_with` union[] - … - `$ends_with` union[] - … - `$more_than` union[] - … - `$less_than` union[] - … - `$more_than_ago` union[] - … - … truncated; see the full OpenAPI document linked below ## Other responses - `404` — Returns an error indicating that the export with given ID was not found if an incorrect ID is provided in the path. --- [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)