@shortcut/client
    Preparing search index...

    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?: null | string;
        created_at?: null | string;
        description?: null | string;
        entity_type: string;
        external_id?: null | string;
        global_id: string;
        id: number;
        name: string;
        stats?: LabelStats;
        updated_at?: null | string;
    }
    Index

    Properties

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

    Properties

    app_url: string

    The Shortcut application url for the Label.

    archived: boolean

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

    color?: null | string

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

    css-color

    1

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

    created_at?: null | string

    The time/date that the Label was created.

    date-time

    description?: null | string

    The description of the Label.

    entity_type: string

    A string description of this resource.

    external_id?: null | 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: string
    id: number

    The unique ID of the Label.

    int64

    name: string

    The name of the Label.

    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.

    updated_at?: null | string

    The time/date that the Label was updated.

    date-time

    Settings

    Member Visibility

    On This Page

    Properties