index
GET
/api/v1/accounts/:account_id/rewards
List rewards
Returns all rewards for the store. Optionally filter by card or active status.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
account_id
|
Must be a number. | Required |
Store (account) ID |
card_id
|
Must be a number. | Optional |
Filter rewards belonging to a specific card |
active
|
Must be a String | Optional |
When present, return only active rewards |
Error Codes
| Code | Description |
|---|---|
401
|
Unauthorized – invalid or missing API token |
404
|
Store not found |
Returns
Code: 200
An array of reward objects
| Name | Type | Required | Description |
|---|---|---|---|
id
|
Must be a Integer | Required |
Unique reward ID |
account_id
|
Must be a Integer | Required |
Parent store ID |
card_id
|
Must be a Integer | Required |
ID of the loyalty card this reward belongs to |
name
|
Must be a String | Required |
Display name of the reward |
description
|
Must be a String | Required |
Longer description of the reward (nil allowed) |
stamps_required
|
Must be a Integer | Required |
Stamps needed before the reward can be redeemed |
position
|
Must be a Integer | Required |
Display order (nil allowed) |
active
|
Must be one of: true, false, 1, 0.
|
Required |
Whether the reward can currently be redeemed |
created_at
|
Must be a String | Required |
ISO 8601 creation timestamp |
updated_at
|
Must be a String | Required |
ISO 8601 last-update timestamp |