The Categories API allows you to manage categories for assets, accessories, consumables, components, and licenses.
List Categories curl -X GET "https://your-domain.com/api/v1/categories" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"
Number of results to return
Search string to filter results
sort
string
default: "assets_count"
Column to sort by. Allowed values: id, name, category_type, use_default_eula, eula_text, require_acceptance, checkin_email, assets_count, accessories_count, consumables_count, components_count, licenses_count
Filter by category type: asset, accessory, consumable, component, license
Total number of categories
Array of category objects Type of category: asset, accessory, consumable, component, or license
EULA text for this category
Whether to use the default EULA
Whether acceptance is required for items in this category
Whether to send email on checkin
Number of assets in this category
Number of accessories in this category
Number of consumables in this category
Number of components in this category
Number of licenses in this category
Get Category by ID curl -X GET "https://your-domain.com/api/v1/categories/{category_id}" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"
Create Category curl -X POST "https://your-domain.com/api/v1/categories" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "name": "Laptops", "category_type": "asset", "require_acceptance": true, "checkin_email": true }'
Type of category. Allowed values: asset, accessory, consumable, component, license
EULA text for this category
Whether to use the default EULA from settings
Whether user acceptance is required when checking out items in this category
Whether to send email notification on checkin
Base64 encoded image or image file
Update Category curl -X PATCH "https://your-domain.com/api/v1/categories/{category_id}" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "name": "Updated Category Name", "require_acceptance": false }'
Delete Category curl -X DELETE "https://your-domain.com/api/v1/categories/{category_id}" \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Accept: application/json"
A category cannot be deleted if it has associated items. You must first reassign or delete all assets, accessories, consumables, components, or licenses in this category.
