> ## Documentation Index
> Fetch the complete documentation index at: https://docs.msportal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List planner items

> Retrieve a paginated list of planner items. Supports filtering by company, type, status, business value, and date range.



## OpenAPI

````yaml /openapi.json get /api/public/v1/planner/items
openapi: 3.0.3
info:
  title: MSPortal Public API
  version: 1.0.0
  description: >-
    Public API for MSPortal - provides programmatic access to tenant data.


    ## Authentication


    All endpoints require authentication via API key passed as a Bearer token:


    ```

    Authorization: Bearer <your-api-key>

    ```


    API keys can be created in the MSPortal dashboard under Settings →
    Integrations → API Access.


    **Important:** Do not include cookies in API requests. The public API uses
    stateless authentication only.


    ## Scopes


    API keys are granted specific scopes that determine what operations they can
    perform. Each endpoint documents its required scope(s).


    ## Rate Limiting


    API calls are rate limited per API key. Rate limit information is returned
    in response headers:


    - `X-RateLimit-Limit`: Maximum requests per minute

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601)


    ## Request ID


    All responses include an `X-Request-Id` header for debugging and support.
    You can also pass your own `X-Request-Id` header to correlate requests.
  contact:
    name: MSPortal Support
    email: support@msportal.ai
  license:
    name: Proprietary
servers:
  - url: https://app.msportal.ai
    description: Production environment
security:
  - BearerAuth: []
tags:
  - name: Budgets
    description: >-
      Budget management - create, track, and forecast budgets with line items,
      categories, and products
  - name: Calendar
    description: Calendar and meeting management - events, participants, and meeting types
  - name: Companies
    description: Company management endpoints
  - name: Company Users
    description: Company user management - client portal contacts (read-only, paginated)
  - name: Compliance
    description: Compliance check management - runs, assigned checks, and status updates
  - name: Dashboards
    description: Dashboard management - external iframe resources and internal dashboards
  - name: Devices
    description: Device management - inventory, types, and locations
  - name: Goals
    description: Goal management - create, track, and manage goals with tasks and updates
  - name: NPS Surveys
    description: >-
      NPS survey management - Net Promoter Score surveys, responses, and
      analytics
  - name: Reports
    description: >-
      Report management - create, manage, and schedule reports with templates
      and types
  - name: Planner
    description: >-
      Planner item management - tasks, roadmap items, and project planning with
      linked goals, compliance, and projects
  - name: Surveys
    description: >-
      General survey management - multi-question surveys, responses, and
      statistics
  - name: Tickets
    description: Ticket management - view and filter tickets from PSA integrations
  - name: Training
    description: >-
      Training management - courses, enrollments, certificates, and progress
      tracking
  - name: Users
    description: Tenant user management - internal staff and team members (read-only)
  - name: Automation Rules
    description: >-
      Automation rule management - create, configure, and monitor automation
      rules with triggers, conditions, and actions
  - name: Analytics
    description: >-
      Analytics and reporting - company audit data, training analytics, user
      activity, and portfolio metrics
paths:
  /api/public/v1/planner/items:
    get:
      tags:
        - Planner
      summary: List planner items
      description: >-
        Retrieve a paginated list of planner items. Supports filtering by
        company, type, status, business value, and date range.
      parameters:
        - schema:
            type: number
            minimum: 1
            default: 1
            description: Page number
          required: false
          description: Page number
          name: page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 25
            description: Items per page
          required: false
          description: Items per page
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - title
              - due_date
              - dueDate
              - start_date
              - startDate
              - status
              - business_value
              - businessValue
              - hours
              - cost_estimate
              - costEstimate
              - created_at
              - createdAt
              - updated_at
              - updatedAt
            default: due_date
            description: Field to sort by
          required: false
          description: Field to sort by
          name: sortColumn
          in: query
        - schema:
            type: boolean
            nullable: true
            default: true
            description: Sort descending
          required: false
          description: Sort descending
          name: sortDesc
          in: query
        - schema:
            type: string
            maxLength: 255
            description: Search in title and description
          required: false
          description: Search in title and description
          name: search
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter by company ID
          required: false
          description: Filter by company ID
          name: companyId
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter by planner item type ID
          required: false
          description: Filter by planner item type ID
          name: typeId
          in: query
        - schema:
            allOf:
              - $ref: '#/components/schemas/PlannerStatus'
              - description: Filter by status
          required: false
          description: Filter by status
          name: status
          in: query
        - schema:
            allOf:
              - $ref: '#/components/schemas/BusinessValue'
              - description: Filter by business value
          required: false
          description: Filter by business value
          name: businessValue
          in: query
        - schema:
            type: boolean
            nullable: true
            default: false
            description: Include archived items
          required: false
          description: Include archived items
          name: isArchived
          in: query
        - schema:
            type: string
            format: date-time
            description: Filter by due date (from)
          required: false
          description: Filter by due date (from)
          name: dueDateFrom
          in: query
        - schema:
            type: string
            format: date-time
            description: Filter by due date (to)
          required: false
          description: Filter by due date (to)
          name: dueDateTo
          in: query
      responses:
        '200':
          description: List of planner items
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Rate limit ceiling
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Remaining requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlannerItemListResponse'
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - Missing required scope (planner.read)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    PlannerStatus:
      type: string
      enum:
        - In Progress
        - Not Started
        - Completed
        - On Hold
        - Cancelled
        - Pending Approval
    BusinessValue:
      type: string
      enum:
        - High
        - Medium
        - Low
    PlannerItemListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlannerItem'
          description: Array of planner items
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        requestId:
          type: string
          description: Request correlation ID
        details:
          nullable: true
          description: Additional error details
        code:
          type: string
          description: Error code
      required:
        - error
    PlannerItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Planner item ID
        title:
          type: string
          description: Item title
        description:
          type: string
          nullable: true
          description: Item description
        status:
          $ref: '#/components/schemas/PlannerStatus'
        businessValue:
          $ref: '#/components/schemas/BusinessValue'
        hours:
          type: number
          minimum: 0
          description: Estimated hours
        costEstimate:
          type: number
          minimum: 0
          description: Cost estimate
        probability:
          type: number
          minimum: 0
          maximum: 100
          description: Completion probability (0-100)
        startDate:
          type: string
          nullable: true
          format: date-time
          description: Start date (ISO 8601)
        dueDate:
          type: string
          nullable: true
          format: date-time
          description: Due date (ISO 8601)
        endDate:
          type: string
          nullable: true
          format: date-time
          description: End date (ISO 8601)
        publicNotes:
          type: string
          nullable: true
          description: Public notes (client-visible)
        privateNotes:
          type: string
          nullable: true
          description: Private notes (internal only, not visible to client portal users)
        isArchived:
          type: boolean
          description: Whether the item is archived
        isOverdue:
          type: boolean
          description: Whether the item is overdue
        fiscalYear:
          type: number
          nullable: true
          description: Fiscal year
        fiscalQuarter:
          type: number
          nullable: true
          description: Fiscal quarter (1-4)
        company:
          $ref: '#/components/schemas/PlannerCompanyRef'
        type:
          $ref: '#/components/schemas/PlannerTypeRef'
        linkedGoalsCount:
          type: number
          description: Number of linked goals
        linkedComplianceCount:
          type: number
          description: Number of linked compliance items
        linkedMeetingsCount:
          type: number
          description: Number of linked meetings
        linkedProjectsCount:
          type: number
          description: Number of linked projects
        linkedSecureScoreCount:
          type: number
          description: Number of linked secure score controls
        tagCount:
          type: number
          description: Number of tags
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
      required:
        - id
        - title
        - description
        - status
        - businessValue
        - hours
        - costEstimate
        - probability
        - startDate
        - dueDate
        - endDate
        - publicNotes
        - privateNotes
        - isArchived
        - isOverdue
        - fiscalYear
        - fiscalQuarter
        - company
        - type
        - linkedGoalsCount
        - linkedComplianceCount
        - linkedMeetingsCount
        - linkedProjectsCount
        - linkedSecureScoreCount
        - tagCount
        - createdAt
        - updatedAt
    Pagination:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
          description: Current page number
        limit:
          type: integer
          minimum: 1
          maximum: 100
          description: Items per page
        totalCount:
          type: integer
          description: Total number of items
        totalPages:
          type: integer
          description: Total number of pages
        hasNextPage:
          type: boolean
          description: Whether there is a next page
        hasPrevPage:
          type: boolean
          description: Whether there is a previous page
      required:
        - page
        - limit
        - totalCount
        - totalPages
        - hasNextPage
        - hasPrevPage
    PlannerCompanyRef:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
          description: Company ID
        name:
          type: string
          description: Company name
      required:
        - id
        - name
    PlannerTypeRef:
      type: object
      nullable: true
      properties:
        id:
          type: string
          format: uuid
          description: Type ID
        name:
          type: string
          description: Type name
      required:
        - id
        - name
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key as a Bearer token. API keys can be generated in
        Settings → Integrations → API Access.

````