Interface Label

A Label can be used to associate and filter Stories and Epics, and also create new Workspaces.

interface Label {
    app_url: string;
    archived: boolean;
    color?: string;
    created_at?: string;
    description?: string;
    entity_type: string;
    external_id?: string;
    global_id: string;
    id: number;
    name: string;
    stats?: LabelStats;
    updated_at?: string;
}

Properties

app_url archived color? created_at? description? entity_type external_id? global_id id name stats? updated_at?

Properties

app_url

app_url: string

The Shortcut application url for the Label.

archived

archived: boolean

A true/false boolean indicating if the Label has been archived.

Optionalcolor

color?: string

The hex color to be displayed with the Label (for example, "#ff0000").

Format

css-color

Min Length

1

Pattern

^#[a-fA-F0-9]{6}$

Optionalcreated_at

created_at?: string

The time/date that the Label was created.

Format

date-time

Optionaldescription

description?: string

The description of the Label.

entity_type

entity_type: string

A string description of this resource.

Optionalexternal_id

external_id?: string

This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.

global_id

global_id: string

id

id: number

The unique ID of the Label.

Format

int64

name

name: string

The name of the Label.

Optionalstats

stats?: LabelStats

A group of calculated values for this Label. This is not included if the slim? flag is set to true for the List Labels endpoint.

Optionalupdated_at

updated_at?: string

The time/date that the Label was updated.

Format

date-time

Settings

Member Visibility

On This Page

Properties