Skip to main content
GET
/
labels
/
read
Read label by id
curl --request GET \
  --url https://api.obselite.com/v0/labels/read \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "color": "<string>",
  "colorKey": "AMBER",
  "key": "CYCLE",
  "organization": {},
  "resources": [
    {}
  ],
  "tasks": [
    {}
  ],
  "teams": [
    {}
  ],
  "activities": [
    {}
  ]
}

Authorizations

Authorization
string
header
required

The API token generated from the Obselite dashboard

Query Parameters

filter
string

Encoded JSON to search and refine lists, see filtering

include
string

Available options: resources, tasks, teams, activities

id
string<uuid>

Response

Successful response

id
string<uuid>
required

Label UUID

name
string
required
colorKey
enum<string>
required
Available options:
AMBER,
BLACK,
BLUE,
CYAN,
EMERALD,
FUCHSIA,
GRAY,
GREEN,
INDIGO,
LIME,
NEUTRAL,
ORANGE,
PINK,
PRIMARY,
PURPLE,
RED,
ROSE,
SKY,
SLATE,
STONE,
TEAL,
VIOLET,
WHITE,
YELLOW,
ZINC
description
string | null
color
string | null
key
enum<string> | null
Available options:
CYCLE,
FEATURE,
ORGANIZATION,
PRODUCT,
PROJECT,
TEAM,
TECHNOLOGY,
TASK,
USER
organization
object | null

The organization that owns this label, following the organization schema

resources
array
tasks
array
teams
array
activities
array