Discount codes
The discount codes your hosts share, what each one takes off, whether it is live, and whether it is synced to your store.
ReferenceUpdated 2 min read
A host discount code credits the host for any order it is used on, including orders with no click, such as a code read out on a podcast. Join codes to orders by host to see what each code sells.
Needs the codes:read scope and a plan that includes Discount codes.
List discount codes#
GET/api/brand/v1/codes
The discount codes your hosts share, and whether each one is synced to your store.
Scopecodes:readPlanDiscount codesListpaginated
Parameters- pageintegeroptionaldefault 1The page to return, starting at 1. At most 10,000.
- per_pageintegeroptionaldefault 25Items per page, between 1 and 100.
- searchstringoptionalMatch on the code or the host, 1 to 100 characters.
- include_inactivebooleanoptionaldefault falseInclude codes that are switched off.
trueorfalse.
A page of codes. data is an array of objects with these attributes, and the body carries pagination.
- idstringThe code id.
- codestringWhat shoppers type at checkout.
- discount_typeenumnullable
percentoramount. - discount_valuenumbernullableThe discount: 15 means 15% or 15 in your currency, by
discount_type. - activebooleanShoppers can use it.
- synced_to_storebooleanThe code exists as a discount in your store.
- hostobjectThe host the code credits.
- idstringThe host’s Rendezvu user id (UUID).
- usernamestringnullableThe host’s handle, as in rendezvu.co/username.
- first_namestringnullableFirst name.
- last_namestringnullableLast name.
- created_attimestampWhen the code was created.
- updated_attimestampWhen it last changed.
curl 'https://api.rendezvu.co/api/brand/v1/codes?per_page=1' \
-H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"Response
{
"success": true,
"data": [
{
"id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
"code": "JORDAN15",
"discount_type": "percent",
"discount_value": 15,
"active": true,
"synced_to_store": true,
"host": {
"id": "6f1c2a9e-3b4d-4e1f-9a8b-2c7d5e6f7a81",
"username": "jordanalpine",
"first_name": "Jordan",
"last_name": "Reyes"
},
"created_at": "2026-05-11T12:00:00.000Z",
"updated_at": "2026-05-11T12:00:00.000Z"
}
],
"pagination": {
"page": 1,
"per_page": 1,
"total_items": 22,
"total_pages": 22,
"has_next": true,
"has_prev": false
},
"_timing": {
"duration_ms": 42
}
}Related
- OrdersEvery order Rendezvu attributed to one of your hosts, across your store and every connected network, with the host's commission on each.
Was this page helpful?