List Labels | Coperniq API

const url = 'https://api.coperniq.io/v1/labels';
const options = {
  method: 'GET',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 101,
    "name": "Urgent",
    "color": "#FF0000",
    "type": "WORK",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-04-10T12:00:00Z"
  },
  {
    "id": 102,
    "name": "Maintenance",
    "color": "#007BFF",
    "type": "WORK",
    "createdAt": "2023-11-20T08:15:00Z",
    "updatedAt": "2024-03-22T14:45:00Z"
  },
  {
    "id": 201,
    "name": "Electrical",
    "color": "#FFA500",
    "type": "ASSET",
    "createdAt": "2024-02-01T10:00:00Z",
    "updatedAt": "2024-05-01T09:00:00Z"
  }
]

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