Get a Comprehensive View of Your Project’s Progress

Stay Up-to-Date on Project Progress

This API endpoint provides you with a list of all activities within your project, including task updates, comments, and status changes. With this information, you can gain a comprehensive view of the progress and changes within your project.

Endpoint

https://api.gitscrum.com/activities/?project_key=KEY&api_id=ID?from_context=project

Method

GET

Authentication

API ID and Project KEY are required for authentication.

Query Parameters

– from_context: The context from which to retrieve the activities. In this case, “project”.

Example Response

{
    "data": [
        {
            "user": {
                "name": "Renato Marinho",
                "headline": "Founder & CEO at GitScrum",
                "username": "renatomarinho",
                "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
            },
            "data": {
                "context": "task",
                "object": {
                    "uuid": "67095ef6-a378-47a5-8f24-cde201d78f9e",
                    "code": "#RRDAY-59",
                    "effort": {
                        "title": "Easy",
                        "effort": "1.00"
                    },
                    "type": {
                        "title": "Night",
                        "color": "#7bd148"
                    },
                    "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": "gather-progress-reports-from-colleagues",
                    "state": null,
                    "title": "Gather progress reports from colleagues",
                    "description": "",
                    "user": {
                        "name": "Renato Marinho",
                        "headline": "Founder & CEO at GitScrum",
                        "username": "renatomarinho",
                        "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
                    },
                    "users": [],
                    "features": [],
                    "completed_user": {
                        "name": "Renato Marinho",
                        "headline": "Founder & CEO at GitScrum",
                        "username": "renatomarinho",
                        "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
                    },
                    "completed_date": {
                        "date_for_humans": "3 days ago",
                        "timezone": "2023-02-10 4:27:20",
                        "timestamp": 1676003240
                    },
                    "start_date": [],
                    "due_date": [],
                    "created_at": {
                        "date_for_humans": "1 month ago",
                        "timezone": "2023-01-12 12:44:11",
                        "timestamp": 1673527451
                    },
                    "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": 0,
                        "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": "renatomarinho",
                            "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": "renatomarinho",
                            "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
                        }
                    },
                    "sprint": {
                        "slug": null,
                        "title": null
                    },
                    "user_story": {
                        "slug": "as-a-manager-i-want-to-be-able-to-under-5e6a66185acb5",
                        "title": "As a manager, I want to be able to understand my colleagues progress, so I can better report our sucess and failures."
                    },
                    "rating": 0,
                    "has_recurring": false,
                    "is_favorite": false
                }
            },
            "project": {
                "slug": "rabbit-day",
                "name": "Rabbit Day",
                "pure_name": "Rabbit Day",
                "logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
                "company": {
                    "slug": "gitscrum",
                    "name": "GitScrum",
                    "logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png"
                },
                "status": {
                    "code": 0,
                    "title": "In Progress"
                },
                "visibility": {
                    "is_private": false,
                    "title": "Public"
                }
            },
            "message": "The task \"Gather progress reports from colleagues\" has been changed to \"Ready to do\" workflow",
            "created_at": {
                "date_for_humans": "3 days ago",
                "timezone": "2023-02-10 5:02:22",
                "timestamp": 1676005342
            }
        },
        {
            "user": {
                "name": "Renato Marinho",
                "headline": "Founder & CEO at GitScrum",
                "username": "renatomarinho",
                "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
            },
            "data": {
                "context": "task",
                "object": {
                    "uuid": "2ad8a70d-8f60-46a5-ac43-88e0211fbd20",
                    "code": "#RRDAY-68",
                    "effort": {
                        "title": "Hard",
                        "effort": "5.00"
                    },
                    "type": {
                        "title": "Morning",
                        "color": "#4986e7"
                    },
                    "timer": true,
                    "has_sprints": true,
                    "has_user_stories": true,
                    "workflow": {
                        "id": 12375,
                        "slug": "todokZBpmf55GM2sDK7I",
                        "state": 0,
                        "title": "Todo",
                        "color": "#3c78d8"
                    },
                    "parent_id": null,
                    "image": null,
                    "labels": [],
                    "slug": "set-up-software",
                    "state": null,
                    "title": "Set up software",
                    "description": "",
                    "user": {
                        "name": "Renato Marinho",
                        "headline": "Founder & CEO at GitScrum",
                        "username": "renatomarinho",
                        "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:59",
                        "timestamp": 1674595859
                    },
                    "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": 0,
                        "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": "renatomarinho",
                            "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": "renatomarinho",
                            "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
                }
            },
            "project": {
                "slug": "rabbit-day",
                "name": "Rabbit Day",
                "pure_name": "Rabbit Day",
                "logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
                "company": {
                    "slug": "gitscrum",
                    "name": "GitScrum",
                    "logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png"
                },
                "status": {
                    "code": 0,
                    "title": "In Progress"
                },
                "visibility": {
                    "is_private": false,
                    "title": "Public"
                }
            },
            "message": "Harrison T. was assigned to task - \"#68 : Set up software\"",
            "created_at": {
                "date_for_humans": "3 days ago",
                "timezone": "2023-02-10 4:58:54",
                "timestamp": 1676005134
            }
        },
        {
            "user": {
                "name": "Renato Marinho",
                "headline": "Founder & CEO at GitScrum",
                "username": "renatomarinho",
                "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
            },
            "data": "TASK_MODAL",
            "project": {
                "slug": "rabbit-day",
                "name": "Rabbit Day",
                "pure_name": "Rabbit Day",
                "logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
                "company": {
                    "slug": "gitscrum",
                    "name": "GitScrum",
                    "logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png"
                },
                "status": {
                    "code": 0,
                    "title": "In Progress"
                },
                "visibility": {
                    "is_private": false,
                    "title": "Public"
                }
            },
            "message": "The task type has been changed",
            "created_at": {
                "date_for_humans": "3 days ago",
                "timezone": "2023-02-10 4:58:46",
                "timestamp": 1676005126
            }
        },
        {
            "user": {
                "name": "Renato Marinho",
                "headline": "Founder & CEO at GitScrum",
                "username": "renatomarinho",
                "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
            },
            "data": "TASK_MODAL",
            "project": {
                "slug": "rabbit-day",
                "name": "Rabbit Day",
                "pure_name": "Rabbit Day",
                "logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
                "company": {
                    "slug": "gitscrum",
                    "name": "GitScrum",
                    "logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png"
                },
                "status": {
                    "code": 0,
                    "title": "In Progress"
                },
                "visibility": {
                    "is_private": false,
                    "title": "Public"
                }
            },
            "message": "The task type has been changed",
            "created_at": {
                "date_for_humans": "3 days ago",
                "timezone": "2023-02-10 4:58:24",
                "timestamp": 1676005104
            }
        },
        {
            "user": {
                "name": "Renato Marinho",
                "headline": "Founder & CEO at GitScrum",
                "username": "renatomarinho",
                "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
            },
            "data": {
                "context": "task",
                "object": {
                    "uuid": "2bffd6a3-119a-4844-af68-2709024d7007",
                    "code": "#RRDAY-70",
                    "effort": {
                        "title": "Easy",
                        "effort": "1.00"
                    },
                    "type": {
                        "title": "Night",
                        "color": "#7bd148"
                    },
                    "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": "test-software-to-ensure-it-meets-requirements",
                    "state": null,
                    "title": "Test software to ensure it meets requirements",
                    "description": "",
                    "user": {
                        "name": "Renato Marinho",
                        "headline": "Founder & CEO at GitScrum",
                        "username": "renatomarinho",
                        "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
                    },
                    "users": [],
                    "features": [],
                    "completed_user": {
                        "name": "Renato Marinho",
                        "headline": "Founder & CEO at GitScrum",
                        "username": "renatomarinho",
                        "avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
                    },
                    "completed_date": {
                        "date_for_humans": "3 days ago",
                        "timezone": "2023-02-10 4:27:14",
                        "timestamp": 1676003234
                    },
                    "start_date": [],
                    "due_date": [],
                    "created_at": {
                        "date_for_humans": "2 weeks ago",
                        "timezone": "2023-01-24 21:31:02",
                        "timestamp": 1674595862
                    },
                    "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": 0,
                        "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": "renatomarinho",
                            "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": "renatomarinho",
                            "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
                }
            },
            "project": {
                "slug": "rabbit-day",
                "name": "Rabbit Day",
                "pure_name": "Rabbit Day",
                "logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
                "company": {
                    "slug": "gitscrum",
                    "name": "GitScrum",
                    "logo": "https://gitscrum-static.s3.amazonaws.com/img/badges/badge-02.png"
                },
                "status": {
                    "code": 0,
                    "title": "In Progress"
                },
                "visibility": {
                    "is_private": false,
                    "title": "Public"
                }
            },
            "message": "The task \"Test software to ensure it meets requirements\" has been changed to \"Ready to do\" workflow",
            "created_at": {
                "date_for_humans": "3 days ago",
                "timezone": "2023-02-10 4:27:14",
                "timestamp": 1676003234
            }
        }
    ]
}

Note

Ensure that you securely store and protect your API ID and Project KEY, as they are required for authentication.

Was this article helpful?

Get a Comprehensive List of Tasks Associated with a Workflow
Get a Comprehensive View of Your Project’s Workflows