Interface LabelSlim

A Label can be used to associate and filter Stories and Epics, and also create new Workspaces. A slim Label does not include aggregate stats. Fetch the Label using the labels endpoint to retrieve them.

Hierarchy

  • LabelSlim

Properties

app_url archived color? created_at? description? entity_type external_id? global_id id name 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.

Optional color

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}$

Optional created_at

created_at?: string

The time/date that the Label was created.

Format

date-time

Optional description

description?: string

The description of the Label.

entity_type

entity_type: string

A string description of this resource.

Optional external_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.

Optional updated_at

updated_at?: string

The time/date that the Label was updated.

Format

date-time

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc