Loading ...

REST API: Get Space Tasks | Communifire Documentation

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

REST API: Get Space Tasks

0 
 /5
0 (0votes)

Get Space Tasks

GET /api/tasks/space/items

Get a list of tasks within a space. 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.
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.
LogView &logView=true - Used in the request URL as a query parameter

Logs the API call as an action in User Activity when set to true

Example Request

GET https://myintranet.communifire.com/api/tasks/space/items?SpaceId=252&FromDate=2024-05-05&ToDate=2024-06-25&token=XWRtaW46

Example Response

Task JSON object is returned as ResponseData.

[
  { "IssueID": 470,
        "MilestoneID": 0,
        "MilestoneTitle": "",
        "TaskSortOrder": 1,
        "IssueTitle": "Update ID card system",
        "CommentCount": 0,
        "IssueDescription": "",
        "IssueDescriptionUnprocessed": "",
        "DateCreated": "2024-05-10T15:08:44.643",
        "ReportedByUserID": 376,
        "AssignedToUserID": 376,
        "OldAssignedToUserID": 376,
        "AssignedToUserDisplayName": "Alexis Fox",
        "ProjectID": 487,
        "ProjectTitle": "New Hire Training",
        "ProjectSectionID": 0,
        "IssueStatusID": 2059,
        "IssueStatusName": "Completed",
        "IssuePriorityID": 0,
        "DateUpdated": "2024-05-15T23:04:17.473",
        "LastUpdatedByUserID": 376,
        "UserID": 0,
        "Rating": 0,
        "OldRating": 0,
        "SpaceID": 252,
        "SpaceName": "Human Resources",
        "StatusColorCssClass": "task-status-completed",
        "IssueStatusType": 2,
        "IsStarred": false,
        "PastDue": true,
        "DateStringTaskEnd": "05/15/2024",
        "IsTaskItem": true,
        "IsCommented": false,
        "IsBillableTask": false,
        "TaskEstimatedHours": 4.0,
        "IsEscalated": false,
        "CopiedFromIssueID": 0,
        "CanCopyCase": false,
        "Latitude": 0.0,
        "Longitude": 0.0,
        "ReferencedEntityID": 0,
        "ReferencedEntityType": 0,
        "WorkflowID": 0,
        "CurrentWorkflowStepID": 0,
        "StatusID": 0,
        "DueDate": "2024-05-16T06:59:55",
        "TenantID": 1
    },
    {
        "IssueID": 469,
        "MilestoneID": 0,
        "MilestoneTitle": "",
        "TaskSortOrder": 1,
        "IssueTitle": "Review new applications",
        "CommentCount": 0,
        "IssueDescription": "",
        "IssueDescriptionUnprocessed": "",
        "DateCreated": "2024-06-06T15:08:24.86",
        "ReportedByUserID": 376,
        "AssignedToUserID": 376,
        "OldAssignedToUserID": 376,
        "AssignedToUserDisplayName": "Alexis Fox",
        "ProjectID": 487,
        "ProjectTitle": "New Hire Training",
        "ProjectSectionID": 0,
        "IssueStatusID": 2059,
        "IssueStatusName": "Completed",
        "IssuePriorityID": 0,
        "DateUpdated": "2024-06-09T22:39:19.043",
        "LastUpdatedByUserID": 376,
        "UserID": 0,
        "Rating": 0,
        "OldRating": 0,
        "SpaceID": 252,
        "SpaceName": "Human Resources",
        "StatusColorCssClass": "task-status-completed",
        "IssueStatusType": 2,
        "IsStarred": false,
        "PastDue": true,
        "DateStringTaskEnd": "06/19/2024",
        "IsTaskItem": true,
        "IsCommented": false,
        "IsBillableTask": false,
        "TaskEstimatedHours": 0.0,
        "IsEscalated": false,
        "CopiedFromIssueID": 0,
        "CanCopyCase": false,
        "Latitude": 0.0,
        "Longitude": 0.0,
        "ReferencedEntityID": 0,
        "ReferencedEntityType": 0,
        "WorkflowID": 0,
        "CurrentWorkflowStepID": 0,
        "StatusID": 0,
        "DueDate": "2024-06-20T06:59:55",
        "TenantID": 1
    }
  ]
}

 

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

 

Wiki Index

Pages

Intranet Software