Get Store category by ID
GET
https://sgtr-api.returning.ai/v1/categories/{categoryID}
Store / Catalog
What this endpoint does
INFO
Quick start
Authentication and permission
| Send | Permission | Community scope |
|---|---|---|
Authorization: Bearer <apiKey> | store | Community scope is derived from the key; do not send a community identifier. |
Complete examples
{pathParameter} and use the query parameters documented below.Success and readback
meta.code = CATEGORY_RETRIEVED{
"meta": {
"status": "success",
"statusCode": 200,
"code": "CATEGORY_RETRIEVED"
},
"message": "Get Store category by ID successfully",
"data": {
"_id": "cat_agent_01",
"name": "Agent Test Rewards",
"displayOrder": 10
}
}CHECK
Errors and recovery
meta.code, never message text.| HTTP | Machine code | What the caller should do | Retry? |
|---|---|---|---|
| 400 | VALIDATION_FAILED | Repair the path ID. | No, fix first |
| 401 | AUTH_API_KEY_REQUIRED | Add the Authorization header. | No, fix first |
| 401 | AUTH_API_KEY_INVALID | Replace or rotate the key. | No, fix first |
| 401 | AUTH_API_KEY_VALIDATION_FAILED | Authentication could not be completed. | Yes, with backoff |
| 403 | AUTH_PERMISSION_REQUIRED | Request the store permission; no resource data is returned. | No, fix first |
| 404 | STORE_RESOURCE_NOT_FOUND | Refresh the category list. | After refreshing the ID |
| 502 | STORE_DEPENDENCY_UNAVAILABLE | Retry after a short backoff; the Store dependency is unavailable. | Yes, with backoff |
| 500 | INTERNAL_ERROR | Retry with exponential backoff and the same request context, then escalate. | Yes, with backoff |
Retry safety
TIP
Gotchas
Next steps
Effective response fields
defaultPurchaseStatusID is the effective status: a non-null stored category override wins; otherwise the active community new_purchase default is returned; it is null when neither exists.categoryPermission[].permission exposes roles, tags, users, combination, and isSelectAll only. Internal permission identifiers are never returned.fields projection may omit these response properties.Request
Path Params
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://sgtr-api.returning.ai/v1/categories/cat_agent_01?fields=name%2CdisplayOrder' \
--header 'Authorization: Bearer XXXXXX'Response Response Example
200 - Success Example
{
"meta": {
"status": "success",
"statusCode": 200,
"code": "CATEGORY_RETRIEVED"
},
"message": "Get Store category by ID successfully",
"data": {
"_id": "cat_agent_01",
"name": "Agent Test Rewards",
"displayOrder": 10,
"defaultPurchaseStatusID": "650906d314a3e564c56f3450",
"categoryPermission": [
{
"isEnabled": true,
"type": "user",
"permission": {
"roles": [
"VIP Member"
],
"tags": [
"Early Access"
],
"users": [
"alex"
],
"combination": [
{
"type": "role",
"values": [
"VIP Member"
]
}
],
"isSelectAll": false
}
}
]
}
}Modified at 2026-08-15 18:35:01