Loading ...

REST API: Get Tasks In List | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Get Tasks In List
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Tasks In List

0 
 /5
0 (0votes)

Get Tasks In List

GET /api/lists/{ListID}/tasks

Get a list of tasks in a specific task list. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
ListID Used in the request URL as a path parameter

Unique ID of the task list.
Optional Parameters How to use Description
TaskStatusType &TaskStatusType=x - Used in the request URL as a query parameter ID of the task status to filter by.
1 = Active
2 = Completed
7 = Assigned to me

Example Request

GET https://myintranet.communifire.com/api/lists/495/tasks?TaskStatusType=1

Example Response

Task JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "TaskID": 488,
      "TaskName": "Prepare paperwork",
      "TaskDescription": "",
      "IssueDescriptionUnprocessed": "",
      "TaskSortOrder": 1,
      "TaskListID": 495,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 595,
      "TaskDueDate": "2018-03-23T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Ben Newman",
      "TaskListName": "Employee Onboarding",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2060,
      "TaskPriorityID": 0,
      "DateCreated": "2018-03-09T03:34:17.543",
      "ReportedByUserID": 376,
      "DateUpdated": "2019-10-01T17:44:40.54",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 10.0,
      "TenantID": 0
    },
    {
      "TaskID": 491,
      "TaskName": "Give access to any tool they will need",
      "TaskDescription": "",
      "IssueDescriptionUnprocessed": "",
      "TaskSortOrder": 2,
      "TaskListID": 495,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 518,
      "TaskDueDate": "2019-06-01T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Julius Kerby",
      "TaskListName": "Employee Onboarding",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2060,
      "TaskPriorityID": 1469,
      "DateCreated": "2018-03-09T03:35:16.543",
      "ReportedByUserID": 376,
      "DateUpdated": "2019-05-28T17:28:25.4",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 0.0,
      "TenantID": 0
    },
    {
      "TaskID": 490,
      "TaskName": "Prepare employee's workstation",
      "TaskDescription": "",
      "IssueDescriptionUnprocessed": "",
      "TaskSortOrder": 4,
      "TaskListID": 495,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 600,
      "TaskDueDate": "2019-06-04T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Joann Martinez",
      "TaskListName": "Employee Onboarding",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2061,
      "TaskPriorityID": 1471,
      "DateCreated": "2018-03-09T03:35:00.84",
      "ReportedByUserID": 376,
      "DateUpdated": "2019-05-28T17:28:33.05",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 0.0,
      "TenantID": 0
    },
    {
      "TaskID": 489,
      "TaskName": "Discuss role, goals, and projects with supervisor",
      "TaskDescription": "Schedule a meeting with the new hire to go over his or her role, the goals to be successful in this role, and upcoming projects. Introduce him/her to the supervisor.",
      "IssueDescriptionUnprocessed": "Schedule a meeting with the new hire to go over his or her role, the goals to be successful in this role, and upcoming projects. Introduce him/her to the supervisor.",
      "TaskSortOrder": 5,
      "TaskListID": 495,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 595,
      "TaskDueDate": "2018-03-24T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Ben Newman",
      "TaskListName": "Employee Onboarding",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2058,
      "TaskPriorityID": 1469,
      "DateCreated": "2018-03-09T03:34:42.933",
      "ReportedByUserID": 376,
      "DateUpdated": "2018-03-12T15:43:14.543",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 2.0,
      "TenantID": 0
    }
  ]
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software