Sign in
Vouchers

List Vouchers

Returns a paginated list of Vouchers imported into the site. The list reflects vouchers managed by an external processor (e.g. GiftPro) that have been synced into Trybe via a previous importVouchers run.

Requires the RESERVATIONS_VIEW permission on the target site.

get/shop/vouchers

Query parameters

site_idstring required

Filter results by the site they belong to

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

A paginated list of imported Vouchers for the requested site.

Example response

{
  "data": [
    {
      "id": "65f0a1b2c3d4e5f6a7b8c9d0",
      "name": "Twilight Spa Day Gift Voucher",
      "description": "A 90-minute treatment, lunch, and full access to the spa facilities.",
      "processor_voucher_id": "gp_8421",
      "price": 12500,
      "currency": "gbp",
      "processor": "giftpro",
      "processor_data": {},
      "valid_offerings": [
        {
          "offering_id": "65f0a1b2c3d4e5f6a7b8c9d1",
          "offering_type": "AppointmentType",
          "offering_name": "60-minute Aromatherapy Massage",
          "offering_details": {
            "membership_type_id": "9c8b7a6d-5e4f-3210-9876-543210fedcba",
            "membership_type_name": "Wellness Club Gold",
            "membership_rate_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
            "membership_rate_name": "Annual rolling",
            "duration": "P1Y",
            "duration_friendly": "1 year"
          }
        }
      ],
      "valid_weekdays": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ],
      "invalid_date_set_ids": [
        "65f0a1b2c3d4e5f6a7b8c9aa"
      ],
      "site_id": "1f3c0e2a-9b8d-4c5e-a6f7-1234567890ab",
      "organisation_id": "0a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "processor_created_at": "2025-12-15T09:30:00+00:00",
      "created_at": "2026-01-04T11:00:00+00:00",
      "updated_at": "2026-04-22T14:18:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.