Item categories
Item-category discovery provides the account-owned category UUIDs required when creating inventory items. The endpoint is read-only and follows the API key user's current inventory permissions.
The item category object
| Field | Type | Description |
|---|---|---|
id | string | Unique item-category UUID. |
object | string | Always item_category. |
name | string | Category name. |
parent_id | string or null | Parent category UUID, or null for a root category. |
inventory_type | string | quantity or unique, based on the category's configured inventory type. |
The response includes only the category fields listed above.
List item categories
GET/api/v3/item-categories
Required scope: items:read
Returns item categories belonging to the current account. Categories follow their configured weight and then sort by name.
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number. Defaults to 1. |
limit | integer | No | Records per page from 1 to 100. Defaults to 20. |
q | string | No | Searches category names. |
parent_id | string | No | Returns direct children of a category UUID. Use root to return root categories. |
curl "https://yourbusiness.salesbinder.com/api/v3/item-categories?parent_id=root&page=1&limit=20" \
--header "Authorization: Bearer YOUR_API_KEY"{
"object": "list",
"url": "/api/v3/item-categories",
"has_more": false,
"data": [
{
"id": "1c7a84de-d045-43ae-b60f-67f75f655ba0",
"object": "item_category",
"name": "Hardware",
"parent_id": null,
"inventory_type": "quantity"
}
],
"pagination": {
"page": 1,
"per_page": 20,
"total_pages": 1,
"total_records": 1
}
}The endpoint uses the standard page-based pagination format. Categories belonging to another account are never returned. A location-restricted user can still discover all categories in their account because categories are account-level reference data rather than location-owned records.
An invalid parent_id returns 422 invalid_query_parameter with parent_id identified as the affected parameter. Filters with no matches return an empty list.