Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

List Members

Returns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.

get/v1/loyalties/{campaignId}/members

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.

customerstring
Example:cust_nk0N1uNQ1YnupAoJGOgvsODC

A tracking identifier of a customer who is the holder of the vouchers. It can be an id generated by Voucherify or the source_id. Remember to use the proper URL escape codes if the source_id contains special characters.

beforestring date-time

Timestamp representing the date and time before the voucher was created. The value is shown in the ISO 8601 format.

afterstring date-time

Timestamp representing the date and time after the voucher was created. The value is shown in the ISO 8601 format.

A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z

{
  "before": "2021-12-22T10:13:06.487Z",
  "after": "2021-12-22T10:13:06.487Z"
}
beforestring date-time

Timestamp representing the date and time before the voucher was updated. The value is shown in the ISO 8601 format.

afterstring date-time

Timestamp representing the date and time after the voucher was updated. The value is shown in the ISO 8601 format.

A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before]=2017-09-08T13:52:18.227Z

{
  "before": "2021-12-22T10:13:06.487Z",
  "after": "2021-12-22T10:13:06.487Z"
}
order'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'code' | '-code'

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

codestring
Example:2CpRCE2c
idsstring[]

Response

Returns a list of loyalty cards within a campaign.

objectstring

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

data_ref'vouchers'

Identifies the name of the attribute that contains the array of voucher objects.

totalinteger

Total number of voucher objects.

Example response

{
  "vouchers": [
    {
      "id": "v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV",
      "code": "WVPblOYX",
      "campaign": "Loyalty campaign",
      "campaign_id": "camp_FNYR4jhqZBM9xTptxDGgeNBV",
      "category_id": "cat_0bb343dee3cdb5ec0c",
      "loyalty_card": {
        "points": 7000,
        "balance": 6970,
        "next_expiration_date": "2023-05-30"
      },
      "start_date": "2021-12-01T00:00:00.000Z",
      "expiration_date": "2021-12-31T00:00:00.000Z",
      "validity_timeframe": {
        "duration": "PT1H",
        "interval": "P2D"
      },
      "validity_hours": {
        "daily": [
          {
            "start_time": "12:00",
            "expiration_time": "14:00"
          }
        ]
      },
      "assets": {
        "qr": {
          "id": "U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==",
          "url": "https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D"
        },
        "barcode": {
          "id": "U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==",
          "url": "https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D"
        }
      },
      "created_at": "2021-12-22T10:13:06.487Z",
      "updated_at": "2021-12-22T10:14:45.316Z",
      "holder_id": "cust_eWgXlBBiY6THFRJwX45Iakv4",
      "publish": {
        "url": "/v1/vouchers/WVPblOYX/publications?page=1&limit=10"
      },
      "redemption": {
        "redeemed_quantity": 1,
        "redeemed_points": 100000,
        "url": "/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"
      }
    }
  ]
}