Create Task Endpoint – GitScrum API Documentation

The endpoint Create Task is used to create a new task in the specified project. The API_ID and PROJECT_KEY parameters should be passed in the query string to authenticate the API request. The request payload should contain the task details in JSON format.

The response payload returns the task_id of the newly created task, along with a message indicating the status of the API request.

Request Method POST

https://api.gitscrum.com/tasks/?project_key=PROJECT_KEY&api_id=API_ID

Request Payload application/json

• title : String ( 255 ) REQUIRED
• description : Longtext OPTIONAL
• value_fixed : Decimal ( e.g: 10.15 ) OPTIONAL
• workflow_id : Number ( See Project Workflows to get workflow_id ) OPTIONAL
• effort_id : Number ( See Task Efforts to get effort_id ) OPTIONAL
• type_id : Number ( See Task Efforts to get type_id ) OPTIONAL
• start_date : Datetime ( e.g.: 2022-11-20 00:00:00 – Format: Y-m-d h:i:s ) OPTIONAL
• due_date : Datetime ( e.g.: 2022-11-20 00:00:00 – Format: Y-m-d h:i:s ) OPTIONAL
• is_draft : Boolean OPTIONAL
• is_archived : Boolean OPTIONAL

Response Status Code 201 Created

{
   "uuid":"49ff4ca2-f441-41fa-8a86-4cc3e3b2a54f",
   "code":"#projd-108",
   "effort":{
      "title":"Template Task Effort 1",
      "effort":"1.00"
   },
   "type":{
      "title":"Template Task Type 1",
      "color":"#38FB07"
   },
   "timer":true,
   "has_sprints":true,
   "has_user_stories":true,
   "workflow":{
      "id":3767,
      "slug":"teste-1-6358dc3b0fb49",
      "state":0,
      "title":"teste-1",
      "color":"#2D0099"
   },
   "parent_id":null,
   "image":null,
   "labels":[],
   "slug":"new-task",
   "state":null,
   "title":"new task",
   "description":"",
   "user":{
      "name":"Renato Marinho de Carvalho",
      "headline":"GitScrum Founder",
      "username":"renato.marinho",
      "avatar":"https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png"
   },
   "users":[],
   "features":[],
   "completed_user":null,
   "completed_date":[],
   "start_date":[],
   "due_date":[],
   "created_at":{
      "date_for_humans":"1 second ago",
      "timezone":"2023-01-28 9:07:47",
      "timestamp":1674896867
   },
   "settings":{
      "is_blocker":false,
      "is_bug":false,
      "is_draft":false,
      "is_archived":true
   },
   "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-storage-avatars.s3.amazonaws.com/37720bcf1e2f3340c54153d4e999c463f27c25c9.png",
      "header_logo":"https://gitscrum-static.s3.amazonaws.com/img/gitscrum-black.png",
      "header_color":"#882A2A",
      "favicon":"https://gitscrum-storage-avatars.s3.amazonaws.com/9575b6c36682f58fd61e981ae843aac6e6e34263.png",
      "owner":{
         "name":"Renato Marinho de Carvalho",
         "headline":"GitScrum Founder",
         "username":"renato.marinho",
         "avatar":"https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png"
      }
   },
   "project":{
      "slug":"project-name-undefined",
      "name":"Project Name Undefined",
      "pure_name":"Project Name Undefined",
      "logo":"https://site.gitscrum.com/images/avatar.png",
      "visibility":{
         "is_private":true,
         "title":"Public"
      },
      "recurring":{
         "enabled":true,
         "max_used":false,
         "limit":999,
         "active":0
      },
      "owner":{
         "name":"Renato Marinho de Carvalho",
         "headline":"GitScrum Founder",
         "username":"renato.marinho",
         "avatar":"https://gitscrum-storage-avatars.s3.amazonaws.com/5467e2bdd31886166112fea09debe9f72aae06dd.png"
      }
   },
   "sprint":{
      "slug":null,
      "title":null
   },
   "user_story":{
      "slug":null,
      "title":null
   },
   "rating":0,
   "has_recurring":false,
   "is_favorite":false
}