Skip to main content
GET
/
{team_id}
/
sprints
Get all sprints for project
curl --request GET \
  --url https://api.superthread.com/v1/{team_id}/sprints
{
  "cursor": "dmsjqh9d8w1hdjosjaasda",
  "count": 14,
  "sprints": [
    {
      "id": "1",
      "team_id": "tDsu0j19",
      "project_id": "2",
      "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
        }
      },
      "title": "Sprint 1",
      "content": "This is the first sprint",
      "state": "planned",
      "lists": [
        {
          "id": "41",
          "team_id": "tDsu0j19",
          "title": "My list",
          "content": "<string>",
          "behavior": "backlog",
          "board_id": "43",
          "user_id": "u981hdaT",
          "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
            }
          },
          "project_id": "5",
          "icon": "shield",
          "color": "<string>",
          "card_order": {},
          "total_cards": 5,
          "time_created": 1608742037016,
          "time_updated": 1608742037016,
          "cards": [
            {
              "id": "2700",
              "type": "card",
              "icon": {
                "type": "image",
                "id": "<string>",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                "color": "black",
                "emoji": "thumbsup"
              },
              "team_id": "tDsu0j19",
              "title": "My Card",
              "content": "Some card content",
              "schema": 1,
              "collaboration": {
                "token": "<string>"
              },
              "status": "started",
              "priority": 1,
              "board_id": "12",
              "board_title": "<string>",
              "list_id": "41",
              "list_color": "<string>",
              "list_title": "<string>",
              "sprint_id": "4s12",
              "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": [
                    "<any>"
                  ]
                }
              ],
              "checklist_order": {},
              "checklist_item_order": {},
              "parent_card": {
                "title": "Implement service requirements",
                "card_id": "42",
                "list_color": "<string>",
                "status": "started"
              },
              "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": "<any>",
                    "time_archived": "<any>"
                  }
                }
              ],
              "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": "<any>",
                    "time_archived": "<any>"
                  },
                  "linked_card_type": "blocks"
                }
              ],
              "archived": {
                "user_id": "<any>",
                "time_archived": "<any>"
              },
              "archived_list": false,
              "archived_board": 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,
              "is_bookmarked": true,
              "project_id": "<string>",
              "external_links": [
                {
                  "type": "github_pull_request",
                  "github_pull_request": {
                    "id": "<any>",
                    "number": "<any>",
                    "state": "<any>",
                    "title": "<any>",
                    "body": "<any>",
                    "html_url": "<any>",
                    "time_created": "<any>",
                    "time_updated": "<any>",
                    "time_closed": "<any>",
                    "time_merged": "<any>",
                    "head": "<any>",
                    "base": "<any>",
                    "draft": "<any>",
                    "merged": "<any>"
                  }
                }
              ],
              "hints": [
                {
                  "type": "tag",
                  "tag": {
                    "name": "<any>"
                  },
                  "relation": {
                    "card": "<any>",
                    "similarity": "<any>"
                  }
                }
              ],
              "estimate": 2,
              "epic": {
                "id": "e-123",
                "title": "Epic Title",
                "icon": {
                  "type": "image",
                  "id": "<string>",
                  "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                  "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                  "color": "black",
                  "emoji": "thumbsup"
                }
              },
              "cover_image": {
                "type": "image",
                "id": "<string>",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                "color": "black",
                "emoji": "thumbsup",
                "positionY": 123,
                "object_fit": "contain"
              },
              "copied_from_card_id": "<string>"
            }
          ],
          "epics": [
            {
              "id": "2700",
              "type": "epic",
              "team_id": "tDsu0j19",
              "icon": {
                "type": "image",
                "id": "<string>",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "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": [
                    "<any>"
                  ]
                }
              ],
              "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": "<any>",
                    "time_archived": "<any>"
                  }
                }
              ],
              "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": "<any>",
                    "time_archived": "<any>"
                  },
                  "linked_card_type": "blocks"
                }
              ],
              "archived": {
                "user_id": "<any>",
                "time_archived": "<any>"
              },
              "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": "<any>",
                    "number": "<any>",
                    "state": "<any>",
                    "title": "<any>",
                    "body": "<any>",
                    "html_url": "<any>",
                    "time_created": "<any>",
                    "time_updated": "<any>",
                    "time_closed": "<any>",
                    "time_merged": "<any>",
                    "head": "<any>",
                    "base": "<any>",
                    "draft": "<any>",
                    "merged": "<any>"
                  }
                }
              ],
              "hints": [
                {
                  "type": "tag",
                  "tag": {
                    "name": "<any>"
                  },
                  "relation": {
                    "card": "<any>",
                    "similarity": "<any>"
                  }
                }
              ],
              "cover_image": {
                "type": "image",
                "id": "<string>",
                "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
                "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
                "color": "black",
                "emoji": "thumbsup",
                "positionY": 123,
                "object_fit": "contain"
              }
            }
          ],
          "archived": {
            "user_id": "<any>",
            "time_archived": "<any>"
          },
          "is_watching": true,
          "webhook_notifications": [
            {
              "webhook": {
                "destination_type": "slack_channel_webhook",
                "integration_id": "42"
              },
              "options": {
                "card_created": true
              }
            }
          ]
        }
      ],
      "unfinished_cards": [
        {
          "id": "2700",
          "type": "card",
          "icon": {
            "type": "image",
            "id": "<string>",
            "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
            "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
            "color": "black",
            "emoji": "thumbsup"
          },
          "team_id": "tDsu0j19",
          "title": "My Card",
          "content": "Some card content",
          "schema": 1,
          "collaboration": {
            "token": "<string>"
          },
          "status": "started",
          "priority": 1,
          "board_id": "12",
          "board_title": "<string>",
          "list_id": "41",
          "list_color": "<string>",
          "list_title": "<string>",
          "sprint_id": "4s12",
          "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": [
                "<any>"
              ]
            }
          ],
          "checklist_order": {},
          "checklist_item_order": {},
          "parent_card": {
            "title": "Implement service requirements",
            "card_id": "42",
            "list_color": "<string>",
            "status": "started"
          },
          "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": "<any>",
                "time_archived": "<any>"
              }
            }
          ],
          "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": "<any>",
                "time_archived": "<any>"
              },
              "linked_card_type": "blocks"
            }
          ],
          "archived": {
            "user_id": "<any>",
            "time_archived": "<any>"
          },
          "archived_list": false,
          "archived_board": 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,
          "is_bookmarked": true,
          "project_id": "<string>",
          "external_links": [
            {
              "type": "github_pull_request",
              "github_pull_request": {
                "id": "<any>",
                "number": "<any>",
                "state": "<any>",
                "title": "<any>",
                "body": "<any>",
                "html_url": "<any>",
                "time_created": "<any>",
                "time_updated": "<any>",
                "time_closed": "<any>",
                "time_merged": "<any>",
                "head": "<any>",
                "base": "<any>",
                "draft": "<any>",
                "merged": "<any>"
              }
            }
          ],
          "hints": [
            {
              "type": "tag",
              "tag": {
                "name": "<any>"
              },
              "relation": {
                "card": "<any>",
                "similarity": "<any>"
              }
            }
          ],
          "estimate": 2,
          "epic": {
            "id": "e-123",
            "title": "Epic Title",
            "icon": {
              "type": "image",
              "id": "<string>",
              "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
              "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
              "color": "black",
              "emoji": "thumbsup"
            }
          },
          "cover_image": {
            "type": "image",
            "id": "<string>",
            "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
            "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
            "color": "black",
            "emoji": "thumbsup",
            "positionY": 123,
            "object_fit": "contain"
          },
          "copied_from_card_id": "<string>"
        }
      ],
      "start_date": 1608742037016,
      "end_date": 1608742037016,
      "override_end_date": 1608742037016,
      "layout": "board",
      "progress": [
        [
          {
            "status": "started",
            "count": 3,
            "pts": 5
          }
        ]
      ],
      "time_created": 1608742037016,
      "time_updated": 1608742037016
    }
  ]
}

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

Query Parameters

project_id
string
required

Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".

archived
boolean

Flag whether to fetch only archived sprints

Response

Array of sprints

cursor
string
required
Example:

"dmsjqh9d8w1hdjosjaasda"

count
integer
required
Example:

14

sprints
object[]