Loading ...

REST API: Get My Tasks | Communifire Documentation

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

REST API: Get My Tasks

0 
 /5
0 (0votes)

Get My Tasks

GET /api/my/tasks/itemslist

Get a list of tasks assigned to you. 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.
ProjectID &ProjectID=x - Used in the request URL as a query parameter

The ID of the project to return tasks for.
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/my/tasks/itemslist?token=XWr1tuPiv

Example Response

Task JSON object is returned as ResponseData.

[
{
  "IssueID": 726,
        "MilestoneID": 0,
        "MilestoneTitle": "",
        "TaskSortOrder": 1,
        "IssueTitle": "Update Employee Handbook",
        "CommentCount": 0,
        "IssueDescription": "The employee handbook needs to be updated to reflect recent changes in company policies and procedures. This includes revising sections on remote work guidelines, performance review processes, and employee benefits.",

        "IssueDescriptionUnprocessed": "The employee handbook needs to be updated to reflect recent changes in company policies and procedures. This includes revising sections on remote work guidelines, performance review processes, and employee benefits.",

        "DateCreated": "2024-07-04T14:59:24.41",
        "ReportedByUserID": 950,
        "AssignedToUserID": 950,
        "OldAssignedToUserID": 950,
        "AssignedToUserDisplayName": "Alexis Fox",
        "ProjectID": 704,
        "ProjectTitle": "Employee Benefits",
        "ProjectSectionID": 0,
        "IssueStatusID": 3726,
        "IssueStatusName": "Active",
        "IssuePriorityID": 2469,
        "IssuePriorityName": "TaskPriorityMediumText",
        "DateUpdated": "2024-07-04T14:59:24.41",
        "LastUpdatedByUserID": 950,
        "UserID": 0,
        "Rating": 0,
        "OldRating": 0,
        "SpaceID": 418,
        "SpaceName": "Human Resources",
        "StatusColorCssClass": "task-status-active",
        "PriorityColorCssClass": "task-priority-medium",
        "IssueStatusType": 1,
        "IsStarred": false,
        "PastDue": false,
        "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,
        "TenantID": 1
    },
    {
        "IssueID": 725,
        "MilestoneID": 0,
        "MilestoneTitle": "",
        "TaskSortOrder": 1,
        "IssueTitle": "Conduct Employee Satisfaction Survey",
        "CommentCount": 0,
        "IssueDescription": "A company-wide employee satisfaction survey needs to be conducted to gather feedback on workplace culture and employee engagement",
        "IssueDescriptionUnprocessed": "A company-wide employee satisfaction survey needs to be conducted to gather feedback on workplace culture and employee engagement",
        "DateCreated": "2024-07-02T16:48:17.07",
        "ReportedByUserID": 950,
        "AssignedToUserID": 950,
        "OldAssignedToUserID": 950,
        "AssignedToUserDisplayName": "Alexis Fox",
        "ProjectID": 701,
        "ProjectTitle": "Survey",
        "ProjectSectionID": 0,
        "IssueStatusID": 2559,
        "IssueStatusName": "Active",
        "IssuePriorityID": 1770,
        "IssuePriorityName": "TaskPriorityMediumText",
        "DateUpdated": "2024-07-02T16:48:17.07",
        "LastUpdatedByUserID": 950,
        "UserID": 0,
        "Rating": 0,
        "OldRating": 0,
        "SpaceID": 418,
        "SpaceName": "Human Resources",
        "StatusColorCssClass": "task-status-active",
        "PriorityColorCssClass": "task-priority-medium",
        "IssueStatusType": 1,
        "IsStarred": false,
        "PastDue": false,
        "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,
        "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