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

# List milestones



## OpenAPI

````yaml /openapi.json get /plans/{planId}/milestones
openapi: 3.0.3
info:
  title: Forecastable Integration API
  version: 1.0.0
  description: >-
    Partner-facing integration REST API at /api/v1. Authenticated requests
    require a bearer token and organization context via X-Organization-Id (or
    organizationId query param on read endpoints). Legacy X-Subscriber-Id and
    subscriberId are still accepted. Approved scopes: organizations:read,
    accounts:read/write/delete, contacts:read/write/delete,
    opportunities:read/write/delete, engage:read/write/send, feed:read,
    plans:read/write/delete, calendar:read/write.
servers:
  - url: https://app.forecastable.com/api/v1
    description: Production
security:
  - BearerAuth: []
tags:
  - name: meta
    description: Integration API foundation metadata.
  - name: organizations
    description: Organization (subscriber) discovery and settings.
  - name: accounts
    description: Account CRUD and bulk operations.
  - name: buying-groups
    description: >-
      Buying groups for an account. Account-level plans attach to the
      default/system buying group ("… Default Plan"). Use
      listAccountBuyingGroups or listBuyingGroups?accountId= before createPlan
      when you need a non-default group.
    x-group: Accounts
  - name: contacts
    description: Account contact CRUD.
  - name: opportunities
    description: Opportunity CRUD.
  - name: leads
    description: Lead CRUD and CRM upsert.
  - name: relationship-maps
    description: Buyer relationship map read and write.
  - name: plans
    description: >-
      Plans (MSPs) for accounts (via default buying group), opportunities,
      buying groups, and personal USER plans. A plan contains milestones, goals,
      and tasks. Use GET /plans/{planId} to load everything in one call. Account
      plans: entityType=ACCOUNT with entityId=<accountId>. Personal plans:
      entityType=USER with entityId=<ownerUserId>.
    x-group: Plans
  - name: plan-milestones
    description: >-
      Ordered phases within a plan. DELETE archives; POST .../restore
      un-archives.
    x-group: Milestones
  - name: plan-goals
    description: Targets attached to a plan. DELETE archives a goal (soft delete).
    x-group: Goals
  - name: plan-tasks
    description: >-
      Work items on a plan, optionally linked to a milestone. GET /tasks lists
      tasks assigned to you across all plans.
    x-group: Tasks
  - name: engage-templates
    description: Engage message templates (email, LinkedIn, Slack). DELETE archives.
    x-group: Engage Templates
  - name: engage-drafts
    description: Engage drafts. Create, read, update, and permanently delete.
    x-group: Engage Drafts
  - name: engage-lists
    description: >-
      Engage lists and members. Manual lists store explicit members; dynamic
      lists derive membership from criteria and are read-only for member
      mutations.
    x-group: Engage Lists
  - name: engage-campaigns
    description: >-
      Engage campaign (flow) definitions, bulk creation, execution status, and
      enrollment job status.
    x-group: Engage Campaigns
  - name: engage-queue
    description: >-
      Read-only outbound queue across channels with per-recipient delivery and
      engagement detail.
    x-group: Engage Queue
  - name: engage-replies
    description: >-
      Read-only inbound replies to Engage sends. Phase 1 exposes email/Nylas
      reply bodies with plain-text by default and optional HTML.
    x-group: Engage Queue
  - name: engage-messages
    description: >-
      Outbound send and campaign start. REST-only: these operations are excluded
      from the MCP tool surface and require an Idempotency-Key header.
    x-group: Engage Messaging
  - name: calendar
    description: >-
      Synced calendar events and linked meeting artifacts (summary, action
      items, transcript) for the authenticated user. Reads may include
      authorized teammate events; updates apply only to viewer-owned events and
      push through the connected calendar provider. Requires a user-backed
      token.
    x-group: Calendar
  - name: feed
    description: >-
      Account inbox (email, Slack, calendar) and dashboard communication
      analytics / needs-attention reads. Requires feed:read. Dashboard endpoints
      require a user-backed token.
    x-group: Feed
paths:
  /plans/{planId}/milestones:
    get:
      tags:
        - plan-milestones
      summary: List milestones
      operationId: listPlanMilestones
      parameters:
        - $ref: '#/components/parameters/OrganizationIdHeader'
        - $ref: '#/components/parameters/OrganizationIdQuery'
        - $ref: '#/components/parameters/PlanId'
      responses:
        '200':
          description: Plan milestones.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MilestoneListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - OAuth2:
            - plans:read
components:
  parameters:
    OrganizationIdHeader:
      name: X-Organization-Id
      in: header
      required: false
      description: >-
        Active organization UUID. Required for authenticated requests when the
        principal has access to multiple organizations.
      schema:
        type: string
        format: uuid
        pattern: >-
          ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
    OrganizationIdQuery:
      name: organizationId
      in: query
      required: false
      description: >-
        Read-only convenience alias for X-Organization-Id. Legacy subscriberId
        query param is also accepted.
      schema:
        type: string
        format: uuid
        pattern: >-
          ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
    PlanId:
      name: planId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        pattern: >-
          ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
  schemas:
    MilestoneListResponse:
      type: object
      additionalProperties: false
      required:
        - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlanMilestone'
    PlanMilestone:
      type: object
      additionalProperties: false
      required:
        - id
        - planId
        - milestone
        - status
        - sortIndex
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        planId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        milestone:
          type: object
          additionalProperties: true
        objective:
          type: object
          additionalProperties: true
          nullable: true
        targetDate:
          type: string
          format: date
          nullable: true
        actualDate:
          type: string
          format: date
          nullable: true
        status:
          $ref: '#/components/schemas/MilestoneStatus'
        sortIndex:
          type: integer
        prospectOwnerIds:
          type: array
          items:
            type: string
            format: uuid
            pattern: >-
              ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        subscriberOwnerIds:
          type: array
          items:
            type: string
            format: uuid
            pattern: >-
              ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/PlanTask'
        goals:
          type: array
          items:
            $ref: '#/components/schemas/PlanGoal'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    ErrorEnvelope:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
    MilestoneStatus:
      type: string
      enum:
        - not_started
        - in_progress
        - completed
    PlanTask:
      type: object
      additionalProperties: false
      required:
        - id
        - planId
        - title
        - completed
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        planId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        milestoneId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        title:
          type: string
        description:
          type: string
          nullable: true
        completed:
          type: boolean
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            When the task was marked completed. Null when incomplete. Set
            automatically when completed flips to true; cleared when completed
            flips to false.
        targetDate:
          type: string
          format: date
          nullable: true
        assignedToId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        createdById:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    PlanGoal:
      type: object
      additionalProperties: false
      required:
        - id
        - planId
        - title
        - goalType
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        planId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
        milestoneId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        title:
          type: string
        description:
          type: string
          nullable: true
        goalType:
          $ref: '#/components/schemas/GoalType'
        target:
          type: number
          nullable: true
        actualValue:
          type: number
          nullable: true
        unitType:
          $ref: '#/components/schemas/UnitType'
          nullable: true
        label:
          type: string
          nullable: true
        progress:
          type: number
          nullable: true
        goalTypeCategory:
          type: string
          nullable: true
        targetDate:
          type: string
          format: date
          nullable: true
        periodType:
          $ref: '#/components/schemas/PeriodType'
          nullable: true
        periodLabel:
          type: string
          nullable: true
        allocations:
          type: object
          additionalProperties: true
          nullable: true
        parentGoalId:
          type: string
          format: uuid
          pattern: >-
            ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
          nullable: true
        childGoals:
          type: array
          items:
            $ref: '#/components/schemas/PlanGoal'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    GoalType:
      type: string
      enum:
        - MILESTONE_BASED
        - QUANTIFIABLE
    UnitType:
      type: string
      enum:
        - NUMBER
        - DOLLAR
        - PERCENTAGE
    PeriodType:
      type: string
      enum:
        - QUARTERLY
        - ANNUAL
        - OTHER
  responses:
    BadRequest:
      description: Validation error or missing subscriber context.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Insufficient scope or organization access.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Resource not found in organization scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Conflict:
      description: Conflict such as duplicate CRM ID.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    UnprocessableEntity:
      description: Semantic validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: api-key or OAuth access token
      description: >-
        Partner integration API key issued from developer settings, or OAuth2
        access token.
    OAuth2:
      type: oauth2
      description: >-
        Partner OAuth2 flows for integration API access tokens. Claude MCP
        custom connectors use authorization code with PKCE S256.
      flows:
        authorizationCode:
          authorizationUrl: /api/v1/oauth/authorize
          tokenUrl: /api/v1/oauth/token
          scopes:
            organizations:read: organizations:read scope for Forecastable Integration API
            accounts:read: accounts:read scope for Forecastable Integration API
            accounts:write: accounts:write scope for Forecastable Integration API
            accounts:delete: accounts:delete scope for Forecastable Integration API
            contacts:read: contacts:read scope for Forecastable Integration API
            contacts:write: contacts:write scope for Forecastable Integration API
            contacts:delete: contacts:delete scope for Forecastable Integration API
            opportunities:read: opportunities:read scope for Forecastable Integration API
            opportunities:write: opportunities:write scope for Forecastable Integration API
            opportunities:delete: opportunities:delete scope for Forecastable Integration API
            engage:read: engage:read scope for Forecastable Integration API
            engage:write: engage:write scope for Forecastable Integration API
            engage:send: engage:send scope for Forecastable Integration API
            feed:read: feed:read scope for Forecastable Integration API
            plans:read: plans:read scope for Forecastable Integration API
            plans:write: plans:write scope for Forecastable Integration API
            plans:delete: plans:delete scope for Forecastable Integration API
            calendar:read: calendar:read scope for Forecastable Integration API
            calendar:write: calendar:write scope for Forecastable Integration API
        clientCredentials:
          tokenUrl: /api/v1/oauth/token
          scopes:
            organizations:read: organizations:read scope for Forecastable Integration API
            accounts:read: accounts:read scope for Forecastable Integration API
            accounts:write: accounts:write scope for Forecastable Integration API
            accounts:delete: accounts:delete scope for Forecastable Integration API
            contacts:read: contacts:read scope for Forecastable Integration API
            contacts:write: contacts:write scope for Forecastable Integration API
            contacts:delete: contacts:delete scope for Forecastable Integration API
            opportunities:read: opportunities:read scope for Forecastable Integration API
            opportunities:write: opportunities:write scope for Forecastable Integration API
            opportunities:delete: opportunities:delete scope for Forecastable Integration API
            engage:read: engage:read scope for Forecastable Integration API
            engage:write: engage:write scope for Forecastable Integration API
            engage:send: engage:send scope for Forecastable Integration API
            feed:read: feed:read scope for Forecastable Integration API
            plans:read: plans:read scope for Forecastable Integration API
            plans:write: plans:write scope for Forecastable Integration API
            plans:delete: plans:delete scope for Forecastable Integration API
            calendar:read: calendar:read scope for Forecastable Integration API
            calendar:write: calendar:write scope for Forecastable Integration API

````