Loading ...

REST API: Get Task List | Communifire Documentation

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

REST API: Get Task List

0 
 /5
0 (0votes)

Get Task List

GET /api/lists/{ListID}

Get a specific task list by its ID. 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.

Example Request

GET https://myintranet.communifire.com/api/lists/495

Example Response

Task list JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "TaskListID": 495,
    "TaskListName": "Employee Onboarding",
    "TaskListDescription": "",
    "IsActive": true,
    "SpaceID": 252,
    "DateCreated": "2018-03-09T03:33:30.62",
    "CanBeDeleted": false,
    "CanBeEdited": false,
    "Tasks": []
  }
}

 

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

 

Wiki Index

Pages

Intranet Software