Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/grokability/snipe-it/llms.txt

Use this file to discover all available pages before exploring further.

The Status Labels API allows you to manage the status labels that define whether assets are deployable, pending, archived, or undeployable.

​
List Status Labels

curl -X GET "https://your-domain.com/api/v1/statuslabels" \
  -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:"created_at"
Column to sort by. Allowed values: id, name, assets_count, color, default_label
​
order
string
default:"desc"
Sort order: asc or desc
​
status_type
string
Filter by status type: deployable, pending, archived, undeployable
​
total
integer
Total number of status labels
​
rows
array
Array of status label objects

​
Get Status Label by ID

curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
​
statuslabel_id
integer
required
The status label ID

​
Create Status Label

curl -X POST "https://your-domain.com/api/v1/statuslabels" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ready to Deploy",
    "type": "deployable",
    "color": "#00FF00",
    "show_in_nav": true
  }'
​
name
string
required
Status label name
​
type
string
required
Status type. Allowed values: deployable, pending, archived, undeployable
​
color
string
Hex color code (e.g., #FF5733)
​
show_in_nav
boolean
default:"false"
Whether to show this status in the navigation sidebar
​
default_label
boolean
default:"false"
Whether this should be the default status label for new assets
​
notes
string
Status label notes
Status Types:
  • deployable: Assets that can be checked out to users
  • pending: Assets awaiting some action (repairs, configuration, etc.)
  • archived: Assets that are no longer in active use
  • undeployable: Assets that cannot be deployed (broken, lost, etc.)

​
Update Status Label

curl -X PATCH "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Status Name",
    "color": "#0000FF"
  }'
​
statuslabel_id
integer
required
The status label ID

​
Delete Status Label

curl -X DELETE "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
​
statuslabel_id
integer
required
The status label ID
A status label cannot be deleted if it has any assets assigned to it. You must first change the status of all associated assets.

​
Check if Deployable

curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}/deployable" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
​
statuslabel_id
integer
required
The status label ID
Returns whether the specified status label is deployable.

​
Get Assets by Status

curl -X GET "https://your-domain.com/api/v1/statuslabels/{statuslabel_id}/assetlist" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
​
statuslabel_id
integer
required
The status label ID
​
limit
integer
default:"50"
Number of results to return
​
offset
integer
default:"0"
Offset for pagination
Returns all assets with the specified status label.

​
Get Asset Count by Status Name

curl -X GET "https://your-domain.com/api/v1/statuslabels/assets/name" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
Returns a count of assets grouped by status label name (useful for charts and dashboards).

​
Get Asset Count by Status Type

curl -X GET "https://your-domain.com/api/v1/statuslabels/assets/type" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
Returns a count of assets grouped by meta status type (deployable, pending, archived, undeployable).