API Documentation
Complete reference for the Incentable REST API. Manage members, points, rewards, and more programmatically.
API Overview
The Incentable API is a RESTful API that allows you to programmatically interact with your incentive programs. Use it to sync data, automate workflows, and build custom integrations.
Base URL
All API requests are made to:
https://api.incentable.com/v1
Authentication
The Incentable API uses API keys for authentication. Include your API key in the Authorization header:
curl -X GET "https://api.incentable.com/v1/members" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Keep your API keys secure. Never expose them in client-side code or public repositories.
Getting Your API Key
- Log in to your Incentable Admin Dashboard
- Navigate to Settings → API Keys
- Click Generate New Key
- Copy and securely store your key
Rate Limits
| Plan | Requests per minute |
|---|---|
| Starter | 60 |
| Professional | 300 |
| Enterprise | Custom |
Response Format
All responses are returned in JSON format:
{
"success": true,
"data": {
// Response data here
},
"meta": {
"page": 1,
"per_page": 25,
"total": 100
}
}
Error Handling
Errors return appropriate HTTP status codes with details:
{
"success": false,
"error": {
"code": "invalid_request",
"message": "The member_id field is required"
}
}
| Status Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |
OpenAPI Specification
Download our OpenAPI 3.0 spec to generate client SDKs or import into your favorite API tool:
Download OpenAPI Spec - Use with Postman, Swagger UI, or to generate SDKs
Next Steps
Ready to start building? Check out the endpoint documentation:
- Members API - Manage program participants
- Points API - Award and manage points
- Rewards API - Handle reward redemptions
- Webhooks - Real-time event notifications
