API Documentation
Custom API reference for integrating with Incentable. RewardStar gift card issuance is available for beta.
API Overview
The Incentable Custom API lets you push data into your program from CRM, ERP, or other systems using standard REST calls and a Bearer API key (inc_…).
Available for beta
| Surface | Status |
|---|---|
| RewardStar API | Available — issue and look up RewardStar gift cards |
Additional surfaces (members, points, rewards catalog, outbound webhooks) are not published in these docs yet — they are still being validated and are hidden from this guide until they are ready for client use.
Base URL
https://us-central1-incentable-app-37d9c.cloudfunctions.net/externalApi/api/v1/external
Authentication
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Keep your API keys secure. Never expose them in client-side code or public repositories.
Getting Your API Key
- Log in to the Incentable Admin Dashboard
- Open Integrations → add or open a Custom API integration
- Enable the permissions you need (for RewardStar: read and/or write)
- Generate the key, copy it once, and store it securely
API keys are scoped to a single program. Optional IP allowlists and rate-limit tiers can be configured on the key.
Rate Limits
Limits follow the key’s rate-limit tier (configured in Admin). Exceeding the limit returns 429.
Errors
Errors use HTTP status codes with a JSON body, for example:
{
"error": "Bad Request",
"message": "Selected denomination is not produced for this card.",
"code": "INVALID_ARGUMENT"
}
Next steps
- RewardStar API — Issue and look up gift cards