[ez-toc]
Returns all workflows with their associated tasks for a given project
This API endpoint provides detailed information about a project’s workflows and their associated tasks. Using this endpoint, you can retrieve all workflows with their corresponding tasks for a specified project. The response includes information such as the workflow and task UUIDs, names, descriptions, due dates, and more, giving you a comprehensive overview of your project’s progress.
Endpoint
https://api.gitscrum.com/projects-workflows-with-tasks/?project_key=KEY&api_id=ID
Method
GET
Authentication
API ID and Project KEY are required for authentication.
Query Parameters
– user_story_slug: refers to a unique identifier that is used to represent a user story
– sprint_slug: refers to a unique identifier that is used to represent a sprint
– is_archived: refers to a unique identifier that is used to represent tasks archived or unarchived. Detault is 0 (unarchived)
Example Response
{
"data": [
{
"id": 12375,
"title": "Todo",
"description": "changed status to \"todo\"",
"autoarchive": 0,
"slug": "todokZBpmf65GM2sDK7I",
"status": {
"code": 0,
"title": "TODO"
},
"color": "#3c78d8",
"position": 1,
"value_fixed": 0,
"default": true,
"emails": "",
"tasks": {
"data": [
{
"uuid": "11108718-42f2-4aaf-bb1d-3df02bc51dbe",
"code": "#RRDAY-67",
"effort": {
"title": "Easy",
"effort": "1.00"
},
"type": {
"title": "Night",
"color": "#7bd148"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 12375,
"slug": "todokZB2mf55GM2sDK7I",
"state": 0,
"title": "Todo",
"color": "#3c78d8"
},
"parent_id": null,
"image": null,
"labels": [],
"slug": "compare-software-options-and-select-a-carrot-management-software",
"state": null,
"title": "Compare software options and select a Carrot Management software",
"description": "",
"user": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
"users": [],
"features": [],
"completed_user": null,
"completed_date": [],
"start_date": [],
"due_date": [],
"created_at": {
"date_for_humans": "2 weeks ago",
"timezone": "2023-01-24 21:30:57",
"timestamp": 1674595857
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": false,
"is_archived": false
},
"time_tracker": null,
"time_tracker_user": null,
"stats": {
"votes": 0,
"fields": 0,
"time_trackers": 0,
"comments": 0,
"checklists": 1,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#CBCBCB",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9decc863043245285a50b2d74adb82ae0fcd384f.png",
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"project": {
"slug": "rabbit-day",
"name": "Rabbit Day",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 99999
},
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": "as-a-bunny-farmer-i-want-to-implement-c-63d04df30ac13",
"title": "As a Bunny Farmer, I want to implement Carrot Management software in order to optimize the management of my carrot harvest"
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
],
"total": 29,
"count": 15,
"per_page": 15,
"current_page": 1,
"total_pages": 2
}
},
{
"id": 12379,
"title": "Ready to do",
"description": "",
"autoarchive": 0,
"slug": "repeat-every-day",
"status": {
"code": 1,
"title": "Done"
},
"color": "#9fc5e8",
"position": 2,
"value_fixed": 0,
"default": false,
"emails": "",
"tasks": {
"data": [
{
"uuid": "549431f8-c2dc-4982-b550-299cce175ae1",
"code": "#RRDAY-71",
"effort": {
"title": "Medium",
"effort": "2.50"
},
"type": {
"title": "Always",
"color": "#a47ae2"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 12379,
"slug": "repeat-every-day",
"state": 1,
"title": "Ready to do",
"color": "#9fc5e8"
},
"parent_id": null,
"image": null,
"labels": [],
"slug": "monitor-software-performance-regularly",
"state": null,
"title": "Monitor software performance regularly",
"description": "",
"user": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
"users": [],
"features": [],
"completed_user": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
"completed_date": {
"date_for_humans": "1 week ago",
"timezone": "2023-02-07 5:30:57",
"timestamp": 1675747857
},
"start_date": [],
"due_date": [],
"created_at": {
"date_for_humans": "2 weeks ago",
"timezone": "2023-01-24 21:31:04",
"timestamp": 1674595864
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": false,
"is_archived": false
},
"time_tracker": null,
"time_tracker_user": null,
"stats": {
"votes": 0,
"fields": 0,
"time_trackers": 0,
"comments": 0,
"checklists": 1,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#CBCBCB",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9decc863043245285a50b2d74adb82ae0fcd384f.png",
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"project": {
"slug": "rabbit-day",
"name": "Rabbit Day",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 99999
},
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": "as-a-bunny-farmer-i-want-to-implement-c-63d04df30ac13",
"title": "As a Bunny Farmer, I want to implement Carrot Management software in order to optimize the management of my carrot harvest"
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
],
"total": 10,
"count": 10,
"per_page": 15,
"current_page": 1,
"total_pages": 1
}
},
{
"id": 12376,
"title": "In Progress",
"description": "changed status to \"in progress\"",
"autoarchive": 0,
"slug": "in-progress",
"status": {
"code": 2,
"title": "In Progress"
},
"color": "#cc0000",
"position": 3,
"value_fixed": 0,
"default": false,
"emails": "",
"tasks": {
"data": [
{
"uuid": "495d2af2-7a2d-4088-b75d-14f4b831b991",
"code": "#RRDAY-65",
"effort": {
"title": "Easy",
"effort": "1.00"
},
"type": {
"title": "Night",
"color": "#7bd148"
},
"timer": true,
"has_sprints": true,
"has_user_stories": true,
"workflow": {
"id": 12376,
"slug": "in-progress",
"state": 2,
"title": "In Progress",
"color": "#cc0000"
},
"parent_id": null,
"image": null,
"labels": [],
"slug": "create-a-list-of-software-requirements",
"state": null,
"title": "Create a list of software requirements",
"description": "",
"user": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
"users": [],
"features": [],
"completed_user": null,
"completed_date": [],
"start_date": [],
"due_date": [],
"created_at": {
"date_for_humans": "2 weeks ago",
"timezone": "2023-01-24 21:30:54",
"timestamp": 1674595854
},
"settings": {
"is_blocker": false,
"is_bug": false,
"is_draft": false,
"is_archived": false
},
"time_tracker": null,
"time_tracker_user": null,
"stats": {
"votes": 0,
"fields": 0,
"time_trackers": 2,
"comments": 0,
"checklists": 1,
"attachments": 0,
"subtasks": 0,
"videos": 0,
"checklist_percentage": 0
},
"company": {
"slug": "gitscrum",
"name": "GitScrum",
"logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png",
"header_logo": "https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
"header_color": "#CBCBCB",
"favicon": "https://gitscrum-storage-avatars.s3.amazonaws.com/9decc863043245285a50b2d74adb82ae0fcd384f.png",
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"project": {
"slug": "rabbit-day",
"name": "Rabbit Day",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
"visibility": {
"is_private": false,
"title": "Public"
},
"recurring": {
"enabled": true,
"limit": 99999
},
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renato.marinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
}
},
"sprint": {
"slug": null,
"title": null
},
"user_story": {
"slug": "as-a-bunny-farmer-i-want-to-implement-c-63d04df30ac13",
"title": "As a Bunny Farmer, I want to implement Carrot Management software in order to optimize the management of my carrot harvest"
},
"rating": 0,
"has_recurring": false,
"is_favorite": false
}
],
"total": 4,
"count": 4,
"per_page": 15,
"current_page": 1,
"total_pages": 1
}
}
]
}
Note
Ensure that you securely store and protect your API ID and Project KEY, as they are required for authentication.