Advanced API Documentation
Campaigns
Contract Documents
Dashboard
Invoices
Invoice Templates
Payment Batches
Payout Methods
Referrals
Rewards
Get available rewards
Get available rewards for current company
HTTP Request
GET https://v2.firstpromoter.com/api/v2/company/rewards
GET
/
rewards
curl --request GET \
--url https://v2.firstpromoter.com/api/v2/company/rewards \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"name": "<string>",
"is_promoter_reward": true,
"promoter_reward_type": "sale",
"coupon": "<string>",
"editable": true,
"hide_reward": true,
"provider_coupon_id": "<string>",
"duration": "once",
"duration_in_months": 123,
"max_redemptions": 123,
"new_customers_only": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"tier_reward_mode": "tier_commission_mode",
"tier_level": 123,
"schemas": [
{
"unit": "cash",
"amount": 123,
"flat_amount": true,
"rules": [
{
"type": "customer_sales_count",
"condition": "less than",
"filter_by": "<string>",
"value": 123,
"operator": "and"
}
]
}
]
}
]
Authorizations
Access token passed as a Bearer token in the Authorization header
Headers
Account identifier that specifies which account is making the request
Example:
"acc_123456"
Query Parameters
Scope of the rewards
Available options:
promoters
, referrals
Response
200
application/json
List of rewards
The response is of type object[]
.
curl --request GET \
--url https://v2.firstpromoter.com/api/v2/company/rewards \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'
[
{
"id": 123,
"name": "<string>",
"is_promoter_reward": true,
"promoter_reward_type": "sale",
"coupon": "<string>",
"editable": true,
"hide_reward": true,
"provider_coupon_id": "<string>",
"duration": "once",
"duration_in_months": 123,
"max_redemptions": 123,
"new_customers_only": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"tier_reward_mode": "tier_commission_mode",
"tier_level": 123,
"schemas": [
{
"unit": "cash",
"amount": 123,
"flat_amount": true,
"rules": [
{
"type": "customer_sales_count",
"condition": "less than",
"filter_by": "<string>",
"value": 123,
"operator": "and"
}
]
}
]
}
]
Assistant
Responses are generated using AI and may contain mistakes.