Epics
Returns epics in the workspace.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Epic unique identifier | |
| Name | String | False |
Epic title (max 256 chars) | |
| Description | String | False |
Detailed description | |
| AppUrl | String | True |
Link to Epic in Shortcut | |
| GlobalId | String | True |
Global unique identifier | |
| IsArchived | Boolean | False |
Archive status | |
| IsCompleted | Boolean | True |
Completion status | |
| IsStarted | Boolean | True |
Start status | |
| State | String | False |
State description The allowed values are done, in progress, to do. | |
| EpicStateId | Integer | False |
Current workflow state ID | |
| RequestedById | String | False |
Members.Id |
Requester UUID |
| OwnerIds | String | False |
Member owner UUIDs array | |
| FollowerIds | String | False |
Follower UUIDs array | |
| GroupId | String | False |
Groups.Id |
Associated group UUID (deprecated) |
| GroupIds | String | False |
Multiple group associations | |
| MilestoneId | Integer | False |
Associated Milestone (deprecated) | |
| ObjectiveIds | String | False |
Related Objective IDs | |
| ProjectIds | String | True |
Deprecated. Associated Project IDs | |
| LabelIds | String | True |
Associated label IDs | |
| Labels | String | False |
Full Label objects array | |
| ExternalId | String | False |
External system reference | |
| EntityType | String | True |
Type identifier | |
| Deadline | Datetime | False |
Target completion date | |
| PlannedStartDate | Datetime | False |
Planned start date | |
| StartedAt | Datetime | True |
Actual start timestamp | |
| StartedAtOverride | Datetime | False |
Manual start override | |
| CompletedAt | Datetime | True |
Completion timestamp | |
| CompletedAtOverride | Datetime | False |
Manual completion override | |
| Position | Integer | True |
Sort order | |
| Stats | String | True |
Aggregated metrics object | |
| StoriesWithoutProjects | Integer | True |
Unassigned story count | |
| ProductboardId | String | True |
External Productboard UUID | |
| ProductboardName | String | True |
External tool name | |
| ProductboardPluginId | String | True |
Plugin identifier | |
| ProductboardUrl | String | True |
External URL | |
| AssociatedGroups | String | True |
Groups linked to Epic | |
| Comments | String | True |
Nested comment structure | |
| Health | String | True |
Current health status object | |
| MemberMentionIds | String | True |
Mentioned member UUIDs | |
| GroupMentionIds | String | True |
Mentioned group UUIDs | |
| MentionIds | String | True |
All mention UUIDs | |
| CreatedAt | Datetime | False |
Creation timestamp | |
| UpdatedAt | Datetime | False |
Last modification timestamp |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| IncludesDescription | Boolean |
Whether to include descriptions. |