Skip to main content
GET
Retrieve coupons

Authorizations

Authorization
string
header
required

See our authentication documentation for how to authorize your requests

Scopes

invoices.readonly

Read contracts, credit notes, discounts and invoices

invoices

Read and write contract, credit notes, discounts and invoices

Headers

spacebring-network-id
string<uuid>

The id of the network. Required when using bearer token authentication

Query Parameters

limit
integer

Maximum number of coupons per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100.

Required range: 1 <= x <= 100
locationRef
string<uuid>

UUID of the location whose coupons to list. Omit to list coupons across every location of the network.

nextPageToken
string

Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page.

type
string

Filter by the product types a coupon applies to; a coupon matches when it applies to any of them. Comma-separated, one or more of: roomBookings, eventSpaceBookings, conferenceRoomBookings, meetingRoomBookings, phoneBoothBookings, stationBookings, studioBookings, hotDeskBookings, dedicatedDeskBookings, officeBookings, parkingBookings, equipmentBookings, eventTickets, shopProducts, packages, subscriptionItems.

Response

Success

coupons
object[]
nextPageToken
string

Opaque cursor token for retrieving the next page of results. Pass this value as the nextPageToken query parameter in your next request.

searchQueryNext
string

Pre-built query string for the next page of results. Contains all active filter parameters combined with the next page token, ready to append to the endpoint URL.