@shortcut/client
    Preparing search index...

    Interface Category

    A Category can be used to associate Objectives.

    interface Category {
        archived: boolean;
        color?: null | string;
        created_at: string;
        entity_type: string;
        external_id?: null | string;
        global_id: string;
        id: number;
        name: string;
        type: string;
        updated_at: string;
    }
    Index

    Properties

    archived color? created_at entity_type external_id? global_id id name type updated_at

    Properties

    archived: boolean

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

    color?: null | string

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

    css-color

    1

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

    created_at: string

    The time/date that the Category was created.

    date-time

    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 Category has been imported from another tool, the ID in the other tool can be indicated here.

    global_id: string

    The Global ID of the Category.

    id: number

    The unique ID of the Category.

    int64

    name: string

    The name of the Category.

    type: string

    The type of entity this Category is associated with; currently Milestone or Objective is the only type of Category.

    updated_at: string

    The time/date that the Category was updated.

    date-time

    Settings

    Member Visibility

    On This Page

    Properties