Loading ...

REST API: Get Tasks | Communifire Documentation

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

REST API: Get Tasks

0 
 /5
0 (0votes)

Get Tasks

GET /api/tasks

Get a list of tasks. 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.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter

Unique ID of the space to get tasks from.
ListID &ListID=x - Used in the request URL as a query parameter

Unique ID of the task list to get tasks from.
AssignedToUser &AssignedToUser=x - Used in the request URL as a query parameter

ID of assigned user to filter the tasks by.
FromDate &FromDate=x - Used in the request URL as a query parameter

Specifies the task due date range.
ToDate &ToDate=x - Used in the request URL as a query parameter

Specifies the task due date range.
TaskStatusType &TaskStatusType=x - Used in the request URL as a query parameter ID of the task status type to filter by.
1 = Active
2 = Completed
7 = Assigned to me

Example Request

GET https://myintranet.communifire.com/api/tasks?SpaceID=252&ListID=487&AssignedToUserID=376&FromDate=10/1/2020&ToDate=10/30/2020&TaskStatusType=1

Example Response

Task JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "TaskID": 470,
      "TaskName": "Update ID card system",
      "TaskDescription": "",
      "IssueDescriptionUnprocessed": "",
      "TaskSortOrder": 1,
      "TaskListID": 487,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 376,
      "TaskDueDate": "2020-10-08T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Alexis Fox",
      "TaskListName": "New Hire Training",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2060,
      "TaskPriorityID": 1469,
      "DateCreated": "2017-10-05T15:08:44.643",
      "ReportedByUserID": 376,
      "DateUpdated": "2020-08-21T23:11:05.053",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 0.0,
      "TenantID": 0
    },
    {
      "TaskID": 468,
      "TaskName": "Prepare hazardous chemical forms",
      "TaskDescription": "",
      "IssueDescriptionUnprocessed": "",
      "TaskSortOrder": 2,
      "TaskListID": 487,
      "IsCompleted": false,
      "SpaceID": 252,
      "AssignedToUserID": 376,
      "TaskDueDate": "2020-10-06T06:59:55",
      "PastDue": false,
      "AssignedToUserDisplayName": "Alexis Fox",
      "TaskListName": "New Hire Training",
      "TaskStatusTypeID": 0,
      "TaskStatusID": 2060,
      "TaskPriorityID": 0,
      "DateCreated": "2017-10-05T15:07:56.887",
      "ReportedByUserID": 376,
      "DateUpdated": "2020-08-21T23:11:13.66",
      "ReferencedEntityID": 0,
      "ReferencedEntityType": 0,
      "TaskEstimatedHours": 0.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