TCN API

ListLabels

POST

https://api.cbf.tcn.com/api/v1alpha1/org/labels/list

Org

ListLabels returns all unique label names belonging to the given org id.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

object {0}

Example

{}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/org/labels/list' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200OK

application/json

Success

Body

Response message for the ListLabels rpc.

labels

array[object (Label) {5}]

labels

optional

name

string

name

optional

simply the name of the label.
'Team A', 'Medical', etc

description

string

description

optional

the description of the label.

color

string

color

optional

Hex color code of the label.

label_id

string

label_id

optional

Id of the label.

deleted

boolean

deleted

optional

whether or not the label is deleted.

Example

{
  "labels": [
    {
      "name": "string",
      "description": "string",
      "color": "string",
      "label_id": "string",
      "deleted": true
    }
  ]
}

🔴500Server Error

DeleteLabel

GetLabel