API ReferenceReference Data
Categories
List product categories or retrieve a single category by ID
GET /api/v1/categories
Returns all active product categories. Requires the vouchers feature to be enabled.
Request
curl https://api.octopuscards.io/api/v1/categories \
-H "Authorization: Bearer <token>"No query parameters.
Response
[
{
"id": 1,
"name": "Gaming"
},
{
"id": 2,
"name": "Mobile Top-Ups"
}
]Response Fields
| Key | Type | Description |
|---|---|---|
id | integer | Unique category identifier |
name | string | Category name |
Only active categories are returned.
Errors
400 Bad Request - Vouchers feature is not enabled for your client.
{
"error": {
"name": "BadRequestError",
"code": "INVALID_FEATURE",
"message": "The requested feature is not enabled for this client"
}
}GET /api/v1/categories/:id
Returns a single category by its ID. Requires the vouchers feature.
Request
curl https://api.octopuscards.io/api/v1/categories/1 \
-H "Authorization: Bearer <token>"Request Parameters
| Key | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Category ID (path parameter) |
Response
{
"id": 1,
"name": "Gaming"
}Response fields are identical to the list endpoint above.
Errors
400 Bad Request - Vouchers feature is not enabled for your client.
{
"error": {
"name": "BadRequestError",
"code": "INVALID_FEATURE",
"message": "The requested feature is not enabled for this client"
}
}