younifyd
Menu

List Publications

List Publications

GET/v1/publications

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the List Publications action (under Publications).
  3. Fill in the fields below, then reference the result from later steps as {{listPublications.response.data}}.

Request

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`.

orderstring

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

One ofid-idvoucher_code-voucher_codetracking_id-tracking_idcustomer_id-customer_idcreated_at-created_atchannel-channel

campaignstring

Filters by a given campaign name.

customerstring

Filters by a unique customer ID.

voucherstring

Filters by a given voucher code.

resultstring

Filters by a publication result.

One ofSUCCESSFAILURE

voucher_typestring

Filters by a voucher type.

One ofdiscountloyalty

is_referral_codeboolean

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

filtersobject

Filters for listing publications.

junctionstring

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.

One ofandor

failure_codeobject1 fields

Filter publications by ids.

resultobject1 fields

Filter publications by names.

customer_idobject1 fields

Filter publications by customer ids.

campaign_nameobject1 fields

Filter publications by campaign names.

voucher_typeobject1 fields

Filter publications by voucher types.

is_referral_codeobject1 fields

Filter publications by is referall code.

parent_object_idobject1 fields

Filter publications by parent object id.

related_object_idobject1 fields

Filter publications by related object id.

source_idobject1 fields

Filter publications by source id.

source_idstring

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

Returns 200 with an object. Read it in later steps with {{listPublications.response.data.<field>}}.

objectstring

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

Default "list"

data_refstring

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

Default "publications"

publicationsarray<oneOf>

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

totalinteger

Total number of publications.

json
{
  "object": "list",
  "data_ref": "publications",
  "publications": [
    null
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.

List Publications — Voucherify — Documentation