@shortcut/client
    Preparing search index...

    Interface Epic

    interface Epic {
        app_url?: string;
        archived?: boolean;
        comments?: NestedThreadedCommentSlimList;
        completed?: boolean;
        completed_at?: string | null;
        completed_at_override?: string | null;
        created_at?: string;
        deadline?: string | null;
        description?: string;
        entity_type?: "epic";
        epic_state?: EpicStateSlim;
        external_id?: string | null;
        followers?: NestedMemberSlimList;
        healths?: NestedHealthSlimList;
        id?: number;
        labels?: NestedLabelSlimList;
        mentioned_members?: NestedMemberSlimList;
        mentioned_teams?: NestedTeamSlimList;
        name?: string;
        objectives?: NestedObjectiveSlimList;
        owners?: NestedMemberSlimList;
        planned_start_date?: string | null;
        requester?: MemberSlim | null;
        started?: boolean;
        started_at?: string | null;
        started_at_override?: string | null;
        stories?: NestedStorySlimList;
        teams?: NestedTeamSlimList;
        updated_at?: string;
        uri?: string;
    }
    Index

    Properties

    app_url? archived? comments? completed? completed_at? completed_at_override? created_at? deadline? description? entity_type? epic_state? external_id? followers? healths? id? labels? mentioned_members? mentioned_teams? name? objectives? owners? planned_start_date? requester? started? started_at? started_at_override? stories? teams? updated_at? uri?

    Properties

    app_url?: string

    The Shortcut application url for the Epic.

    2048

    ^https?://.+$

    archived?: boolean

    Whether the Epic is archived.

    comments?: NestedThreadedCommentSlimList

    The Comments on the Epic.

    completed?: boolean

    Whether the Epic is completed.

    completed_at?: string | null

    The time/date the Epic was completed.

    date-time

    completed_at_override?: string | null

    A manual override for the time/date the Epic was completed.

    date-time

    created_at?: string

    The time/date the Epic was created.

    date-time

    deadline?: string | null

    The Epic's deadline.

    date-time

    description?: string

    The Epic's description.

    entity_type?: "epic"

    The type of this entity.

    epic_state?: EpicStateSlim

    The current Epic State.

    external_id?: string | null

    An external ID that can be used to identify the Epic.

    followers?: NestedMemberSlimList

    The Members who followers of the Doc.

    healths?: NestedHealthSlimList

    The Health updates on the Objective.

    id?: number

    The unique ID of the Epic.

    int64

    labels?: NestedLabelSlimList

    A list of labels attached to the Story.

    mentioned_members?: NestedMemberSlimList

    The Members who followers of the Doc.

    mentioned_teams?: NestedTeamSlimList

    A list of Teams that this Member belongs to.

    name?: string

    The name of the Epic.

    objectives?: NestedObjectiveSlimList

    The Objectives associated with this Epic.

    owners?: NestedMemberSlimList

    The Members who followers of the Doc.

    planned_start_date?: string | null

    The Epic's planned start date.

    date-time

    requester?: MemberSlim | null

    The Member who created the Doc.

    started?: boolean

    Whether the Epic has been started.

    started_at?: string | null

    The time/date the Epic was started.

    date-time

    started_at_override?: string | null

    A manual override for the time/date the Epic was started.

    date-time

    stories?: NestedStorySlimList

    A list of Stories associated with this Project.

    teams?: NestedTeamSlimList

    A list of Teams that this Member belongs to.

    updated_at?: string

    The time/date the Epic was last updated.

    date-time

    uri?: string

    A resolvable URI for the entity.

    2048

    ^https?://.+$

    Settings

    Member Visibility

    On This Page

    Properties