Retrieve all details about an epic (project) in a workspace (team_id).
Use this endpoint to see the description, progress, tasks and other metadata about a project.
curl --request GET \
--url https://api.superthread.com/v1/{team_id}/epics/{epic_id}{
"epic": {
"id": "2700",
"type": "epic",
"team_id": "tDsu0j19",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "My Card",
"schema": 1,
"content": "Some card content",
"collaboration": {
"token": "<string>"
},
"list_id": "41",
"list_color": "<string>",
"list_title": "<string>",
"status": "started",
"priority": 1,
"owner_id": "uR2dws11",
"user_id": "uR2dws11",
"user_id_updated": "u2erXoQq",
"user": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"user_updated": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"start_date": 1608742037016,
"due_date": 1608742037016,
"completed_date": 1608742037016,
"time_created": 1608742037016,
"time_updated": 1608742037016,
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"checklists": [
{
"id": "232",
"title": "My Checklist",
"content": "Some description",
"card_id": "32",
"user_id": "uG2sdaOn",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"items": [
{
"id": "4312",
"title": "Some title",
"content": "Some description",
"checklist_id": "432",
"user_id": "u-du9saoj1",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"checked": true
}
]
}
],
"checklist_order": {},
"checklist_item_order": {},
"child_cards": [
{
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "us4Fsfed",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "55",
"list_title": "Done",
"list_color": "<string>",
"status": "started",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
}
}
],
"child_card_order": {},
"linked_cards": [
{
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "42",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "list 1",
"list_title": "list 1",
"status": "started",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"linked_card_type": "blocks"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"archived_list": false,
"tags": [
{
"id": "u-dsu0j19",
"team_id": "u-dsu0j19",
"project_id": "5",
"name": "todo",
"slug": "todo",
"color": "blue",
"total_cards": 17
}
],
"total_comments": 3,
"total_files": 1,
"is_watching": true,
"external_links": [
{
"type": "github_pull_request",
"github_pull_request": {
"id": 123,
"number": 123,
"state": "<string>",
"title": "<string>",
"body": "<string>",
"html_url": "<string>",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"time_closed": 1608742037016,
"time_merged": 1608742037016,
"head": {
"label": "<string>",
"ref": "<string>"
},
"base": {
"label": "<string>",
"ref": "<string>"
},
"draft": true,
"merged": true
},
"generic": {
"url": "<string>",
"id": "550e8400-e29b-41d4-a716-446655440000",
"display_text": "<string>",
"time_added": 1608742037016
}
}
],
"hints": [
{
"type": "tag",
"tag": {
"name": "bug"
},
"relation": {
"card": {
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "us4Fsfed",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "55",
"list_title": "Done",
"list_color": "<string>",
"status": "started"
},
"similarity": 0.8
}
}
],
"cover_image": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup",
"positionY": 123,
"object_fit": "contain"
}
}
}Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".
Epic ID is a numerical string that identifies an Epic. This is externally referred to as a "Project".
Epic card response
Show child attributes
"2700"
Type of the object being returned
"epic"
"tDsu0j19"
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"My Card"
Content schema version
1
102400"Some card content"
"41"
cached field
cached field
committed, started, completed, cancelled "started"
1
"uR2dws11"
"uR2dws11"
"u2erXoQq"
describes a user or robot that created or updated a resource
Show child attributes
"uDsu0j19"
user, robot, system "user"
describes the source of an actor
Show child attributes
oauth, import, email, agent "oauth"
client ID if the resource was created via oauth2 app
"oczapier"
import ID if the resource was created by an import
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
agent ID if the resource was created by an agent
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
email address if the resource was created via an email
whether the email sender was verified
false
describes a user or robot that created or updated a resource
Show child attributes
"uDsu0j19"
user, robot, system "user"
describes the source of an actor
Show child attributes
oauth, import, email, agent "oauth"
client ID if the resource was created via oauth2 app
"oczapier"
import ID if the resource was created by an import
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
agent ID if the resource was created by an agent
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
email address if the resource was created via an email
whether the email sender was verified
false
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
Show child attributes
"232"
"My Checklist"
"Some description"
"32"
"uG2sdaOn"
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
Show child attributes
"4312"
"Some title"
"Some description"
"432"
"u-du9saoj1"
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
true
string array representing an order of IDs
Show child attributes
"Create illustration for upcoming holidays"
"42"
"us4Fsfed"
"3"
"15"
"Ideas"
"55"
"Done"
committed, started, completed, cancelled "started"
string array representing an order of IDs
Show child attributes
"Create illustration for upcoming holidays"
"42"
"42"
"3"
"15"
"Ideas"
"list 1"
"list 1"
committed, started, completed, cancelled "started"
blocks, blocked_by, related, duplicates "blocks"
whether the epic is in an archived list
false
Show child attributes
"u-dsu0j19"
"u-dsu0j19"
"5"
"todo"
"todo"
fog, slate, grey, charcoal, black, red, orange, yellow, green, ocean, blue, purple, pink "blue"
number of cards that use this tag
17
3
1
whether current user is a watcher of this epic
true
Show child attributes
github_pull_request, generic Show child attributes
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
Show child attributes
Unique identifier for this external link (UUID)
"550e8400-e29b-41d4-a716-446655440000"
unix timestamp in seconds
1608742037016
Show child attributes
defines the type of hint
tag, relation "tag"
Show child attributes
Show child attributes
"Create illustration for upcoming holidays"
"42"
"us4Fsfed"
"3"
"15"
"Ideas"
"55"
"Done"
committed, started, completed, cancelled "started"
similarity score between 0 and 1
0.8
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
contain, cover curl --request GET \
--url https://api.superthread.com/v1/{team_id}/epics/{epic_id}{
"epic": {
"id": "2700",
"type": "epic",
"team_id": "tDsu0j19",
"icon": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"title": "My Card",
"schema": 1,
"content": "Some card content",
"collaboration": {
"token": "<string>"
},
"list_id": "41",
"list_color": "<string>",
"list_title": "<string>",
"status": "started",
"priority": 1,
"owner_id": "uR2dws11",
"user_id": "uR2dws11",
"user_id_updated": "u2erXoQq",
"user": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"user_updated": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"start_date": 1608742037016,
"due_date": 1608742037016,
"completed_date": 1608742037016,
"time_created": 1608742037016,
"time_updated": 1608742037016,
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016,
"role": "admin"
}
],
"checklists": [
{
"id": "232",
"title": "My Checklist",
"content": "Some description",
"card_id": "32",
"user_id": "uG2sdaOn",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"items": [
{
"id": "4312",
"title": "Some title",
"content": "Some description",
"checklist_id": "432",
"user_id": "u-du9saoj1",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"checked": true
}
]
}
],
"checklist_order": {},
"checklist_item_order": {},
"child_cards": [
{
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "us4Fsfed",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "55",
"list_title": "Done",
"list_color": "<string>",
"status": "started",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
}
}
],
"child_card_order": {},
"linked_cards": [
{
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "42",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "list 1",
"list_title": "list 1",
"status": "started",
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"linked_card_type": "blocks"
}
],
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"archived_list": false,
"tags": [
{
"id": "u-dsu0j19",
"team_id": "u-dsu0j19",
"project_id": "5",
"name": "todo",
"slug": "todo",
"color": "blue",
"total_cards": 17
}
],
"total_comments": 3,
"total_files": 1,
"is_watching": true,
"external_links": [
{
"type": "github_pull_request",
"github_pull_request": {
"id": 123,
"number": 123,
"state": "<string>",
"title": "<string>",
"body": "<string>",
"html_url": "<string>",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"time_closed": 1608742037016,
"time_merged": 1608742037016,
"head": {
"label": "<string>",
"ref": "<string>"
},
"base": {
"label": "<string>",
"ref": "<string>"
},
"draft": true,
"merged": true
},
"generic": {
"url": "<string>",
"id": "550e8400-e29b-41d4-a716-446655440000",
"display_text": "<string>",
"time_added": 1608742037016
}
}
],
"hints": [
{
"type": "tag",
"tag": {
"name": "bug"
},
"relation": {
"card": {
"title": "Create illustration for upcoming holidays",
"card_id": "42",
"user_id": "us4Fsfed",
"project_id": "3",
"board_id": "15",
"board_title": "Ideas",
"list_id": "55",
"list_title": "Done",
"list_color": "<string>",
"status": "started"
},
"similarity": 0.8
}
}
],
"cover_image": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup",
"positionY": 123,
"object_fit": "contain"
}
}
}