List Publications

Retrieve a list of publications. To return a **particular** publication, you can use the `source_id` query parameter and provide the `source_id` of the publication you are looking for specifically. ## Pagination <!-- theme: warning --> > 🚧 Important! > > If you want to scroll through a huge set of records, it is recommended to use the <!-- [Exports API](OpenAPI.json/components/schemas/16_obj_export_object) -->[Exports API](ref:create-export). This API will return an error `page_over_limit` if you reach a page above 1000. ## Filter Query The `filters` query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows: <!-- title: "Filter template" --> ```url filters[<field_name>][conditions][<operator>][<index>]=<value> ``` ### Operators: <!-- title: "Operators" --> ``` "$in" "$not_in" "$is" "$is_not" "$has_value" "$is_unknown" "$contains" "$starts_with" "$ends_with" "$more_than" "$less_than" "$more_than_equal" "$less_than_equal" ``` ### Examples <!-- title: "Example 1 - List publications of a given customer" --> ```url GET /v1/publications?filters[customer_id][conditions][$is][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL ``` <!-- title: "Example 2 - List publications of 2 customers" --> ```url GET /v1/publications?filters[customer_id][conditions][$in][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL&filters[customer_id][conditions][$in][1]=cust_aR7NfHusxT7PdTMAKMfWDXnc ``` <!-- title: "Example 3 - List publications of 2 customers using junction operator" --> ```url GET /v1/publications?filters[customer_id][conditions][$is][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL&filters[customer_id][conditions][$is][1]=cust_aR7NfHusxT7PdTMAKMfWDXnc&filters[junction]=OR ```

Authorizations

X-App-Id · string · header · required

X-App-Token · string · header · required

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

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:

id,

-id,

voucher_code,

-voucher_code,

tracking_id,

-tracking_id,

customer_id,

-customer_id,

created_at,

-created_at,

channel,

-channel

campaign · string

Filters by a given campaign name.

customer · string

Filters by a unique customer ID.

Example:

"cust_nk0N1uNQ1YnupAoJGOgvsODC"

voucher · string

Filters by a given voucher code.

Example:

"2CpRCE2c"

result · enum<string>

Filters by a publication result.

Available options:

SUCCESS,

FAILURE

voucher_type · enum<string>

Filters by a voucher type.

Available options:

discount,

loyalty

is_referral_code · boolean

This filter works only for the true option. If set to true, the query returns only publications of codes from referral campaigns.

filters · object

Filters for listing publications.

Show child attributes

source_id · string

Using this endpoint with a particular publication source_id, which was sent with the original request to create a publication, returns in the response, exactly the same code published initially because the code was assigned to the given publication. As a result, you can use this endpoint as a reference and return a code that was assigned in a publication by using a particular source_id.

Response

200

application/json

Returns a list of publications you've previously created with <!-- [create publication](OpenAPI.json/paths/~1publications/post) -->create publication or implicitly by the distribution manager. The publications are returned in sorted order, with the most recent ones appearing first.

Response body schema for listing publications using GET v1/publications.

object · string · default: list · required

The type of the object represented by JSON. This object stores information about publications in a dictionary.

data_ref · string · default: publications · required

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

publications · (Valid Single Voucher · object | Valid Multiple Vouchers · object | Invalid · object)[] · required

Contains array of publication objects, voucher object will be simplified.

Valid Single Voucher

Show child attributes

total · integer · required

Total number of publications.