[ez-toc]
Retrieve Detailed Information About Your Project
This API endpoint provides you with detailed information about your project, including its name, description, start and end dates, and status. With this information, you can get a clear understanding of the current state of your project and make informed decisions to keep your workflow running smoothly.
Endpoint
https://api.gitscrum.com/projects/?project_key=KEY&api_id=ID
Method
GET
Authentication
API ID and Project KEY are required for authentication.
Parameters
None
Example Response
{
"data": {
"id": 3038,
"slug": "rabbit-day",
"name": "Rabbit Day",
"budget": {
"raw": 0,
"formatted": 0
},
"code": "RRDAY",
"logo": "https://gitscrum-storage-avatars.s3.amazonaws.com/58cb78e94d967f43a6364435484ad3a26a83a48e.png",
"description": "Keep your team motivated and increase performance with personalized boards. Easily evaluate performance so you can reward your Biggest Rock Stars.\n\n",
"category_id": null,
"background": null,
"background_thumb": null,
"slack_webhook": "",
"discord_webhook": "https://discordapp.com/api/webhooks/515660342913452544/lZdsdxIQxtBpCQaSx9qHIQYNO5jIefSJrSbetzYfXlLds3ZTVoYv29uAOTHSVK8d-",
"percent": 44,
"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"
},
"integration": {
"github": {
"connected": false,
"full_name": null,
"html_url": null
}
},
"dates": {
"start": {
"date_for_humans": "1 year ago",
"timezone": "2021-08-01 0:00:00",
"timestamp": 1627776000
},
"due": {
"date_for_humans": "5 months ago",
"timezone": "2022-08-20 0:00:00",
"timestamp": 1660953600
}
},
"stats": {
"total": 57,
"open": 29,
"progress": 3,
"closed": 25
},
"labels": [
{
"id": 1,
"slug": "testecpWorxyayO",
"title": "Frontend",
"color": "#8e7cc3",
"projects": null
},
{
"id": 2,
"slug": "content-creation0IhQPOY8RG",
"title": "Content Creation",
"color": "#16a765",
"projects": null
},
{
"id": 3,
"slug": "jhhjhjjhhjfEHddKCSr6",
"title": "Ideas",
"color": "#1155cc",
"projects": null
},
{
"id": 4,
"slug": "dsfdsdfsdft1UeWsieGd",
"title": "Prototypes",
"color": "#00ff00",
"projects": null
},
{
"id": 5,
"slug": "sdfasdfasdfasdfsGpZUYpxw7",
"title": "Experiments",
"color": "#ff9900",
"projects": null
},
{
"id": 6,
"slug": "label-1xgzpoNqlsI",
"title": "Sales",
"color": "#351c75",
"projects": null
},
{
"id": 7,
"slug": "copywriterDA2dfycgJG",
"title": "Copywriter",
"color": "#9900ff",
"projects": null
},
{
"id": 8,
"slug": "opopopopm96FclATy",
"title": "opopopo",
"color": "#20124d",
"projects": null
}
],
"owner": {
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renatomarinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
"users": [
{
"name": " Robin E.",
"headline": "\"If you can dream it, you can do it.\" WDisney",
"username": "robin",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/c6e2f3ba9caeb635252cf1387c67a3be652c1253.png"
},
{
"name": "Elizabeth F.",
"headline": "",
"username": "elizabeths",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/dc9253a511a5bab4aa4339aaaac984ecda227154.png"
},
{
"name": "Harrison T.",
"headline": "",
"username": "harrison",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/4820cd74ba9f8c10765c5801a6c04cb3394a721c.png"
},
{
"name": "Renato Marinho",
"headline": "Founder & CEO at GitScrum",
"username": "renatomarinho",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/b9467bcfd59b6fbab1b4e5e98f79d8816a77a346.png"
},
{
"name": "Oliver Smith",
"headline": "",
"username": "oliver",
"avatar": "https://gitscrum-storage-avatars.s3.amazonaws.com/7e5e922a8a025e5b76653cb3ab105c24ffbeeebe.png"
}
],
"settings": {
"max_wip": 10,
"use_timer": true,
"task_type": true,
"task_effort": true,
"show_number": true,
"show_value_fixed": true,
"has_overview": true,
"has_board": true,
"has_time_tracking": true,
"has_wiki": true,
"has_mind_mapping": true,
"has_spreadsheet": true,
"has_discussions": true,
"has_documents": true,
"has_form2task": true,
"has_rockstar_team": true,
"has_calendar": true,
"has_user_stories": true,
"has_sprints": true,
"has_gantt": true
},
"sidebar": [
{
"href": {
"name": "projects.board",
"params": {
"companySlug": "gitscrum",
"projectSlug": "rabbit-day"
}
},
"title": "Tasks",
"icon": "window"
}
],
"logged_user_role": "",
"my_contribution": 43,
"recurring": {
"enabled": true,
"limit": 99999
},
"created_at": {
"date_for_humans": "4 years ago",
"timezone": "2018-08-24 13:10:45",
"timestamp": 1535116245
}
}
}
Note
Ensure that you securely store and protect your API ID and Project KEY, as they are required for authentication.