label

List labels

List the labels belonging to the partner the API key belongs to. Returns only public labels — private labels are an internal ProVision concept and are never exposed here. Use this endpoint to discover the labelId values accepted by the label assignment endpoints. Supports pagination (limit, offset), filters (a URL-encoded JSON array of { attribute, operator, value } conditions), and sort; results are ordered by displayName unless sort says otherwise. Requires the label:read scope.

GET

labels

List labels

curl --request GET \
  --url https://connect.provisionapp.io/v1/labels \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/labels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "labelId": "<string>",
      "displayName": "<string>",
      "labelGroupId": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Send the API key in the x-api-key header.

Query Parameters

limit

integer

default:20

Required range: 1 <= x <= 100

offset

integer | null

default:0

Required range: x >= 0

filters

string

A URL-encoded JSON array of filter conditions, all AND-ed together. Each condition is { "attribute", "operator", "value", "valueType"? }. Allowed attributes: labelId, displayName, labelGroupId. Allowed operators: =, !=, in, not_in, ilike, not_ilike, <, <=, >, >=, is_null, is_not_null. value is always a string; set valueType (one of boolean, number, number[], string, string[]) to coerce it — e.g. "boolean" for a true/false attribute or "string[]" for the in operator.

sort

string

Comma-separated list of fields to sort by, applied in order; prefix a field with - for descending. Allowed fields: displayName, labelGroupId.

Response

Paginated list of labels

data

object[]

required

Show child attributes

meta

object

required

Show child attributes

List labels

curl --request GET \
  --url https://connect.provisionapp.io/v1/labels \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/labels', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "labelId": "<string>",
      "displayName": "<string>",
      "labelGroupId": "<string>"
    }
  ],
  "meta": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

system

site

conversation

client

label

site-file

user

project

signal-incident

List labels

Authorizations

Query Parameters

Response