Interface Group

A Group.

interface Group {
    app_url: string;
    archived: boolean;
    color?: string;
    color_key?:
        | "blue"
        | "purple"
        | "midnight-blue"
        | "orange"
        | "yellow-green"
        | "brass"
        | "gray"
        | "fuchsia"
        | "yellow"
        | "pink"
        | "sky-blue"
        | "green"
        | "red"
        | "black"
        | "slate"
        | "turquoise";
    description: string;
    display_icon: 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[];
}

Properties

app_url archived color? color_key? 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

app_url: string

The Shortcut application url for the Group.

archived

archived: boolean

Whether or not the Group is archived.

Optionalcolor

color?: string

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

Format

css-color

Min Length

1

Pattern

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

Optionalcolor_key

color_key?:
    | "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.

description

description: string

The description of the Group.

display_icon

display_icon: Icon

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

entity_type

entity_type: string

A string description of this resource.

global_id

global_id: string

id

id: string

The id of the Group.

Format

uuid

member_ids

member_ids: string[]

The Member IDs contain within the Group.

mention_name

mention_name: string

The mention name of the Group.

Min Length

1

Pattern

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

name

name: string

The name of the Group.

num_epics_started

num_epics_started: number

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

Format

int64

num_stories

num_stories: number

The total number of stories assigned to the group.

Format

int64

num_stories_backlog

num_stories_backlog: number

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

Format

int64

num_stories_started

num_stories_started: number

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

Format

int64

workflow_ids

workflow_ids: number[]

The Workflow IDs contained within the Group.

Settings

Member Visibility

On This Page

Properties