Interface Epic

An Epic is a collection of stories that together might make up a release, a objective, or some other large initiative that you are working on.

Hierarchy

  • Epic

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.

comments: ThreadedComment[]

A nested array of threaded comments.

completed: boolean

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

completed_at?: string

The time/date the Epic was completed.

Format

date-time

completed_at_override?: string

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

Format

date-time

created_at?: string

The time/date the Epic was created.

Format

date-time

deadline?: string

The Epic's deadline.

Format

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.

Format

int64

external_id?: 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?: string

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

Format

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.

Format

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?: number

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

Format

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?: string

The Epic's planned start date.

Format

date-time

position: number

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

Format

int64

productboard_id?: string

The ID of the associated productboard feature.

Format

uuid

productboard_name?: string

The name of the associated productboard feature.

productboard_plugin_id?: string

The ID of the associated productboard integration.

Format

uuid

productboard_url?: 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.

Format

uuid

started: boolean

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

started_at?: string

The time/date the Epic was started.

Format

date-time

started_at_override?: string

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

Format

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.

Format

int64

updated_at?: string

The time/date the Epic was updated.

Format

date-time

Generated using TypeDoc