v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Exports

List Exports

List all exports.

get/v1/exports

Query parameters

limitinteger

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.

pageinteger

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

order'created_at' | '-created_at' | 'status' | '-status'

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

Response

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.

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.

totalinteger required

Total number of exports.