Close menu
Explore Plans
Mobile menu Close menu
Shortcut

List epics

Pro plus icon List the active (non-archived) epics in your Shortcut workspace, most recently updated first.

Developer info

API endpoint slug
shortcut.list_epics
Runtime method
performQuery("shortcut.list_epics"}

Query fields

No fields for this query

Ingredients

Epic The unique identifier for the epic in Shortcut.

Slug
epic_id
Filter code
Shortcut.listEpics.EpicId
Type
String
Example
123

Epic name The title or name of the epic.

Slug
epic_name
Filter code
Shortcut.listEpics.EpicName
Type
String
Example
Q1 User Authentication Overhaul

Epic url The direct URL to view the epic in the Shortcut web application.

Slug
epic_url
Filter code
Shortcut.listEpics.EpicUrl
Type
Web URL
Example
https://app.shortcut.com/myworkspace/epic/123

Epic description The detailed description of the epic's goals and scope.

Slug
epic_description
Filter code
Shortcut.listEpics.EpicDescription
Type
String
Example
Complete overhaul of user authentication system.

Epic state The current state of the epic (e.g. to do, in progress, done).

Slug
epic_state
Filter code
Shortcut.listEpics.EpicState
Type
String
Example
in progress

Created at The timestamp when the epic was originally created.

Slug
created_at
Filter code
Shortcut.listEpics.CreatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Updated at The timestamp when the epic was last modified.

Slug
updated_at
Filter code
Shortcut.listEpics.UpdatedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Completed at The timestamp when the epic was marked as completed.

Slug
completed_at
Filter code
Shortcut.listEpics.CompletedAt
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00

Requested by The unique identifier of the team member who requested this epic.

Slug
requested_by_id
Filter code
Shortcut.listEpics.RequestedById
Type
String
Example
a1b2c3d4-e5f6-7890-1234-567890abcdef

Milestone The unique identifier of the milestone associated with this epic, if any.

Slug
milestone_id
Filter code
Shortcut.listEpics.MilestoneId
Type
String
Example
456

Deadline The target completion date for the epic, if set.

Slug
deadline
Filter code
Shortcut.listEpics.Deadline
Type
Date with time (ISO8601)
Example
2020-07-08T04:17:06+05:00