Skip to main content
GET
/
api
/
public
/
v1
/
planner
/
items
List planner items
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/planner/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "status": "In Progress",
      "businessValue": "High",
      "hours": 1,
      "costEstimate": 1,
      "probability": 50,
      "startDate": "2023-11-07T05:31:56Z",
      "dueDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "publicNotes": "<string>",
      "privateNotes": "<string>",
      "isArchived": true,
      "isOverdue": true,
      "fiscalYear": 123,
      "fiscalQuarter": 123,
      "company": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "type": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "linkedGoalsCount": 123,
      "linkedComplianceCount": 123,
      "linkedMeetingsCount": 123,
      "linkedProjectsCount": 123,
      "linkedSecureScoreCount": 123,
      "tagCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
sortColumn
enum<string>
default:due_date

Field to sort by

Available options:
title,
due_date,
dueDate,
start_date,
startDate,
status,
business_value,
businessValue,
hours,
cost_estimate,
costEstimate,
created_at,
createdAt,
updated_at,
updatedAt
​
sortDesc
boolean | null
default:true

Sort descending

​
search
string

Search in title and description

Maximum string length: 255
​
companyId
string<uuid>

Filter by company ID

​
typeId
string<uuid>

Filter by planner item type ID

​
status
enum<string>

Filter by status

Available options:
In Progress,
Not Started,
Completed,
On Hold,
Cancelled,
Pending Approval
​
businessValue
enum<string>

Filter by business value

Available options:
High,
Medium,
Low
​
isArchived
boolean | null
default:false

Include archived items

​
dueDateFrom
string<date-time>

Filter by due date (from)

​
dueDateTo
string<date-time>

Filter by due date (to)

Response

List of planner items

​
data
object[]
required

Array of planner items

​
pagination
object
required