GET
/
labels
List labels
curl --request GET \
  --url https://api.portkey.ai/v1/labels \
  --header 'x-portkey-api-key: <api-key>'
{
  "total": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "color_code": "<string>",
      "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_universal": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "status": "<string>"
    }
  ]
}

Authorizations

​
x-portkey-api-key
string
header
required

Query Parameters

​
organisation_id
string<uuid>

ID of the organisation

​
workspace_id
string

ID or slug of the workspace

​
search
string

Search query to filter labels by name

​
current_page
integer

Page number for pagination

Required range: x >= 0
​
page_size
integer

Number of items per page

Required range: x >= 1

Response

List of labels

​
total
integer

Total number of labels

​
data
object[]