Skip to navigation
API ReferenceLabels

List Labels

Lists active labels for your company. Labels can be applied to work orders (WORK type) or assets (ASSET type). The company is implied by the API key.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

typeenumOptional
Filter by label type
Allowed values:
pageintegerOptional>=1Defaults to 1

Page number (1-based)

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

Response

List of labels
idinteger
Label identifier
namestring
Label display name
colorstring or null

Label color as a hex code (e.g. “#FF5733”), or null if unset

typeenum

Label type — WORK for work-order labels, ASSET for asset labels

Allowed values:
createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
502
Bad Gateway Error