GET
/
v1
/
promotion-codes
curl -X GET 'https://api.tolt.com/v1/promotion-codes' \
-H 'Authorization: Bearer <API_KEY>'

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
      "code": "SUMMER2024",
      "type": "percentage",
      "value": 20,
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
    }
  ]
}

​
Base URL https://api.tolt.com


​
Query Parameters

​
program_id*
string

The program ID from where you want to list the partners.

​
partner_id
string - optional

Only return promotion codes from this partner

​
order
asc | desc - optional

The order of the promotion codes to return by created_at. Default is desc

​
expand
array - optional

Specify which related objects to include in the response. Valid values are ‘partner’ and ‘program’. Use expand[]=partner or expand[]=program to include the related objects.

​
created_gte
string - optional

Only return promotion codes created after this date

​
created_lte
string - optional

Only return promotion codes created before this date

​
limit
string - optional

A limit on the number of promotion codes to return. Default is 10, max is 100

​
starting_after
string - optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list

​
ending_before
string - optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list

​
Response

​
success
boolean

Whether the request was successful

​
has_more
boolean

Whether there are more pages of results available

​
total_count
integer

Total number of promotion codes matching the query

​
data
array[Object]
curl -X GET 'https://api.tolt.com/v1/promotion-codes' \
-H 'Authorization: Bearer <API_KEY>'

{
  "success": true,
  "has_more": true,
  "total_count": 45,
  "data": [
    {
      "id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
      "code": "SUMMER2024",
      "type": "percentage",
      "value": 20,
      "partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
      "created_at": "2025-01-15T14:30:00.000Z",
      "updated_at": "2025-01-15T14:30:00.000Z",
      "program_id": "prg_YRsbPDAKhWfdqJbFACheh",
      "organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
    }
  ]
}