List coupon codes across organisations
Returns a paginated list of every CouponCode visible to the calling user across every organisation they belong to. Use the code query filter to look up a single redemption code without knowing which coupon it belongs to — handy when a customer presents a code at point of sale and the staff member needs to navigate to the owning coupon.
Each entry includes the organisation_id of the owning coupon so consumers can route follow-up calls to the correct /shop/organisations/{organisationId}/... resource.
Requires the RESERVATIONS_VIEW permission on at least one site.
Query parameters
Exact-match filter on the redemption code. Pair with pagination if you expect more than one match.
The page to retrieve results from
The number of results to return per page
Response
A paginated list of coupon codes visible to the calling user across every organisation they are scoped to.
Example response
{
"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"
},
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"data": [
{
"id": "5f1234567890abcdef123456",
"coupon_id": "5f1234567890abcdef123456",
"code": "SUMMER2026",
"valid_from_date": "2026-06-01T00:00:00+00:00",
"valid_to_date": "2026-08-31T23:59:59+00:00",
"organisation_id": "00000000-0000-0000-0000-000000000000"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.