Categories

Manage categories via the API

The Categories API allows you to manage categories for assets, accessories, consumables, components, and licenses.

List Categories

cURL

curl -X GET "https://your-domain.com/api/v1/categories" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

limit · integer · default: "50"

Number of results to return

offset · integer · default: "0"

Offset for pagination

search · string

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

order · string · default: "desc"

Sort order: asc or desc

category_type · string

Filter by category type: asset, accessory, consumable, component, license

total · integer

Total number of categories

rows · array

Array of category objects

Show Category Object

id · integer

Category ID

name · string

Category name

category_type · string

Type of category: asset, accessory, consumable, component, or license

eula_text · string

EULA text for this category

use_default_eula · boolean

Whether to use the default EULA

require_acceptance · boolean

Whether acceptance is required for items in this category

checkin_email · boolean

Whether to send email on checkin

assets_count · integer

Number of assets in this category

accessories_count · integer

Number of accessories in this category

consumables_count · integer

Number of consumables in this category

components_count · integer

Number of components in this category

licenses_count · integer

Number of licenses in this category

notes · string

Category notes

image · string

Category image URL

Get Category by ID

cURL

curl -X GET "https://your-domain.com/api/v1/categories/{category_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

category_id · integer · required

The category ID

Create Category

cURL

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
  }'

name · string · required

Category name

category_type · string · required

Type of category. Allowed values: asset, accessory, consumable, component, license

eula_text · string

EULA text for this category

use_default_eula · boolean · default: "false"

Whether to use the default EULA from settings

require_acceptance · boolean · default: "false"

Whether user acceptance is required when checking out items in this category

checkin_email · boolean · default: "false"

Whether to send email notification on checkin

notes · string

Category notes

image · string

Base64 encoded image or image file

Update Category

cURL

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
  }'

category_id · integer · required

The category ID

Delete Category

cURL

curl -X DELETE "https://your-domain.com/api/v1/categories/{category_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

category_id · integer · required

The category ID

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.