@shortcut/client
    Preparing search index...

    Interface Group

    A Group.

    interface Group {
        app_url: string;
        archived: boolean;
        color?: null | string;
        color_key?:
            | null
            | "blue"
            | "purple"
            | "midnight-blue"
            | "orange"
            | "yellow-green"
            | "brass"
            | "gray"
            | "fuchsia"
            | "yellow"
            | "pink"
            | "sky-blue"
            | "green"
            | "red"
            | "black"
            | "slate"
            | "turquoise";
        default_workflow_id?: null
        | number;
        description: string;
        display_icon: null | Icon;
        entity_type: string;
        global_id: string;
        id: string;
        member_ids: string[];
        mention_name: string;
        name: string;
        num_epics_started: number;
        num_stories: number;
        num_stories_backlog: number;
        num_stories_started: number;
        workflow_ids: number[];
    }
    Index

    Properties

    app_url archived color? color_key? default_workflow_id? description display_icon entity_type global_id id member_ids mention_name name num_epics_started num_stories num_stories_backlog num_stories_started workflow_ids

    Properties

    app_url: string

    The Shortcut application url for the Group.

    archived: boolean

    Whether or not the Group is archived.

    color?: null | string

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

    css-color

    1

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

    color_key?:
        | null
        | "blue"
        | "purple"
        | "midnight-blue"
        | "orange"
        | "yellow-green"
        | "brass"
        | "gray"
        | "fuchsia"
        | "yellow"
        | "pink"
        | "sky-blue"
        | "green"
        | "red"
        | "black"
        | "slate"
        | "turquoise"

    The color key to be displayed with the Group.

    default_workflow_id?: null | number

    The ID of the default workflow for stories created in this group.

    int64

    description: string

    The description of the Group.

    display_icon: null | Icon

    Icons are used to attach images to Groups, Workspaces, Members, and Loading screens in the Shortcut web application.

    entity_type: string

    A string description of this resource.

    global_id: string
    id: string

    The id of the Group.

    uuid

    member_ids: string[]

    The Member IDs contain within the Group.

    mention_name: string

    The mention name of the Group.

    1

    ^[a-z0-9-_.]+$

    name: string

    The name of the Group.

    num_epics_started: number

    The number of epics assigned to the group which are in the started workflow state.

    int64

    num_stories: number

    The total number of stories assigned to the group.

    int64

    num_stories_backlog: number

    The number of stories assigned to the group which are in a backlog workflow state.

    int64

    num_stories_started: number

    The number of stories assigned to the group which are in a started workflow state.

    int64

    workflow_ids: number[]

    The Workflow IDs contained within the Group.

    Settings

    Member Visibility

    On This Page

    Properties