@shortcut/client
    Preparing search index...

    Interface EpicSlim

    EpicSlim represents the same resource as an Epic but is more light-weight, including all Epic fields except the comments array. The description string can be optionally included. Use the Get Epic endpoint to fetch the unabridged payload for an Epic.

    interface EpicSlim {
        app_url: string;
        archived: boolean;
        associated_groups: EpicAssociatedGroup[];
        completed: boolean;
        completed_at?: null | string;
        completed_at_override?: null | string;
        created_at?: null | string;
        deadline?: null | string;
        description?: string;
        entity_type: string;
        epic_state_id: number;
        external_id?: null | string;
        follower_ids: string[];
        global_id: string;
        group_id?: null | string;
        group_ids: string[];
        group_mention_ids: string[];
        id: number;
        label_ids: number[];
        labels: LabelSlim[];
        member_mention_ids: string[];
        mention_ids: string[];
        milestone_id?: null | number;
        name: string;
        objective_ids: number[];
        owner_ids: string[];
        planned_start_date?: null | string;
        position: number;
        productboard_id?: null | string;
        productboard_name?: null | string;
        productboard_plugin_id?: null | string;
        productboard_url?: null | string;
        project_ids: number[];
        requested_by_id: string;
        started: boolean;
        started_at?: null | string;
        started_at_override?: null | string;
        state: string;
        stats: EpicStats;
        stories_without_projects: number;
        updated_at?: null | string;
    }
    Index

    Properties

    app_url archived associated_groups completed completed_at? completed_at_override? created_at? deadline? description? entity_type epic_state_id external_id? follower_ids global_id group_id? group_ids group_mention_ids id label_ids labels member_mention_ids mention_ids milestone_id? name objective_ids owner_ids planned_start_date? position productboard_id? productboard_name? productboard_plugin_id? productboard_url? project_ids requested_by_id started started_at? started_at_override? state stats stories_without_projects updated_at?

    Properties

    app_url: string

    The Shortcut application url for the Epic.

    archived: boolean

    True/false boolean that indicates whether the Epic is archived or not.

    associated_groups: EpicAssociatedGroup[]

    An array containing Group IDs and Group-owned story counts for the Epic's associated groups.

    completed: boolean

    A true/false boolean indicating if the Epic has been completed.

    completed_at?: null | string

    The time/date the Epic was completed.

    date-time

    completed_at_override?: null | string

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

    date-time

    created_at?: null | string

    The time/date the Epic was created.

    date-time

    deadline?: null | string

    The Epic's deadline.

    date-time

    description?: string

    The Epic's description.

    entity_type: string

    A string description of this resource.

    epic_state_id: number

    The ID of the Epic State.

    int64

    external_id?: null | string

    This field can be set to another unique ID. In the case that the Epic has been imported from another tool, the ID in the other tool can be indicated here.

    follower_ids: string[]

    An array of UUIDs for any Members you want to add as Followers on this Epic.

    global_id: string
    group_id?: null | string

    Deprecated The ID of the group to associate with the epic. Use group_ids.

    uuid

    group_ids: string[]

    An array of UUIDS for Groups to which this Epic is related.

    group_mention_ids: string[]

    An array of Group IDs that have been mentioned in the Epic description.

    id: number

    The unique ID of the Epic.

    int64

    label_ids: number[]

    An array of Label ids attached to the Epic.

    labels: LabelSlim[]

    An array of Labels attached to the Epic.

    member_mention_ids: string[]

    An array of Member IDs that have been mentioned in the Epic description.

    mention_ids: string[]

    Deprecated: use member_mention_ids.

    milestone_id?: null | number

    Deprecated The ID of the Objective this Epic is related to. Use objective_ids.

    int64

    name: string

    The name of the Epic.

    objective_ids: number[]

    An array of IDs for Objectives to which this epic is related.

    owner_ids: string[]

    An array of UUIDs for any members you want to add as Owners on this new Epic.

    planned_start_date?: null | string

    The Epic's planned start date.

    date-time

    position: number

    The Epic's relative position in the Epic workflow state.

    int64

    productboard_id?: null | string

    The ID of the associated productboard feature.

    uuid

    productboard_name?: null | string

    The name of the associated productboard feature.

    productboard_plugin_id?: null | string

    The ID of the associated productboard integration.

    uuid

    productboard_url?: null | string

    The URL of the associated productboard feature.

    project_ids: number[]

    The IDs of Projects related to this Epic.

    requested_by_id: string

    The ID of the Member that requested the epic.

    uuid

    started: boolean

    A true/false boolean indicating if the Epic has been started.

    started_at?: null | string

    The time/date the Epic was started.

    date-time

    started_at_override?: null | string

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

    date-time

    state: string

    Deprecated The workflow state that the Epic is in.

    stats: EpicStats

    A group of calculated values for this Epic.

    stories_without_projects: number

    The number of stories in this epic which are not associated with a project.

    int64

    updated_at?: null | string

    The time/date the Epic was updated.

    date-time

    Settings

    Member Visibility

    On This Page

    Properties