Loading ...

REST API: Get Task Lists | Communifire Documentation

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

REST API: Get Task Lists

0 
 /5
0 (0votes)

Get Task Lists

GET /api/lists

Get a list of task lists in a specific 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.
SpaceID &SpaceID=x - Used in the request URL as a query parameter

Unique ID of the space.

Example Request

GET https://myintranet.communifire.com/api/lists?SpaceID=252

Example Response

Task list JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "TaskListID": 495,
      "TaskListName": "Employee Onboarding",
      "TaskListDescription": "",
      "IsActive": true,
      "SpaceID": 252,
      "UserID": 123,
      "DateCreated": "2018-03-09T03:33:30.62",
      "CanBeDeleted": true,
      "CanBeEdited": true,
      "Tasks": [],
      "UserDisplayName:"Alexis Fox"
    },
    {
      "TaskListID": 487,
      "TaskListName": "New Hire Training",
      "TaskListDescription": "Get new hires up to speed with current processes.",
      "IsActive": true,
      "SpaceID": 252,
      "UserID": 123,
      "DateCreated": "2017-10-05T15:06:55.18", 
      "CanBeDeleted": true, 
      "CanBeEdited": true, 
      "Tasks": [],
      "UserDisplayName:"Alexis Fox"
    }, 
    { 
      "TaskListID": 488, 
      "TaskListName": "Weekly Processes", 
      "TaskListDescription": "", 
      "IsActive": true, 
      "SpaceID": 252,
      "UserID": 123,
      "DateCreated": "2017-10-05T15:10:23.26", 
      "CanBeDeleted": true, 
      "CanBeEdited": true, 
      "Tasks": [],
      "UserDisplayName:"Alexis Fox"
    } 
  ] 
}

 

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

 

Wiki Index

Pages

Intranet Software