Members API
Create, retrieve, update, and manage members in your incentive program.
Members API
The Members API allows you to programmatically manage participants in your incentive program.
List Members
Retrieve a paginated list of all members.
GET /v1/members
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
per_page | integer | Results per page (default: 25, max: 100) |
status | string | Filter by status: active, inactive, pending |
search | string | Search by name or email |
Example Request
curl -X GET "https://api.incentable.com/v1/members?status=active&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
Example Response
{
"success": true,
"data": [
{
"id": "mem_abc123",
"email": "john@example.com",
"first_name": "John",
"last_name": "Smith",
"points_balance": 5000,
"tier": "Gold",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}
],
"meta": {
"page": 1,
"per_page": 10,
"total": 156
}
}
Get Member
Retrieve a single member by ID.
GET /v1/members/{member_id}
Example Request
curl -X GET "https://api.incentable.com/v1/members/mem_abc123" \
-H "Authorization: Bearer YOUR_API_KEY"
Create Member
Add a new member to your program.
POST /v1/members
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Member's email address |
first_name | string | Yes | First name |
last_name | string | Yes | Last name |
company | string | No | Company name |
phone | string | No | Phone number |
metadata | object | No | Custom key-value data |
Example Request
curl -X POST "https://api.incentable.com/v1/members" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Doe",
"company": "Acme Corp",
"metadata": {
"region": "North",
"sales_rep_id": "SR-456"
}
}'
Example Response
{
"success": true,
"data": {
"id": "mem_xyz789",
"email": "jane@example.com",
"first_name": "Jane",
"last_name": "Doe",
"company": "Acme Corp",
"points_balance": 0,
"status": "active",
"created_at": "2024-06-15T14:22:00Z"
}
}
Update Member
Update an existing member's information.
PATCH /v1/members/{member_id}
Example Request
curl -X PATCH "https://api.incentable.com/v1/members/mem_abc123" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"company": "New Company Name",
"metadata": {
"region": "South"
}
}'
Delete Member
Remove a member from your program.
DELETE /v1/members/{member_id}
This action is irreversible. Consider setting the member's status to
inactive instead.Example Request
curl -X DELETE "https://api.incentable.com/v1/members/mem_abc123" \
-H "Authorization: Bearer YOUR_API_KEY"