> ## 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.

# Get integration API metadata

> Public foundation endpoint describing auth, scopes, pagination, and rate limits.



## OpenAPI

````yaml /openapi.json get /meta
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:
  /meta:
    get:
      tags:
        - meta
      summary: Get integration API metadata
      description: >-
        Public foundation endpoint describing auth, scopes, pagination, and rate
        limits.
      operationId: getMeta
      responses:
        '200':
          description: Integration API metadata.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
        '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: []
components:
  schemas:
    MetaResponse:
      type: object
      additionalProperties: false
      required:
        - name
        - version
        - status
        - auth
        - scopes
        - pagination
        - rateLimiting
      properties:
        name:
          type: string
        version:
          type: string
        status:
          type: string
          enum:
            - ok
        auth:
          type: object
          additionalProperties: false
          required:
            - bearer
            - organizationHeader
            - allowCognitoJwtBeta
          properties:
            bearer:
              type: boolean
            organizationHeader:
              type: string
            legacySubscriberHeader:
              type: string
              description: >-
                Deprecated header alias still accepted for backward
                compatibility.
            allowCognitoJwtBeta:
              type: boolean
        scopes:
          type: array
          items:
            type: string
            enum:
              - organizations:read
              - accounts:read
              - accounts:write
              - accounts:delete
              - contacts:read
              - contacts:write
              - contacts:delete
              - opportunities:read
              - opportunities:write
              - opportunities:delete
              - engage:read
              - engage:write
              - engage:send
              - feed:read
              - plans:read
              - plans:write
              - plans:delete
              - calendar:read
              - calendar:write
        pagination:
          type: object
          additionalProperties: false
          required:
            - cursor
            - offsetCompatibility
          properties:
            cursor:
              type: boolean
            offsetCompatibility:
              type: boolean
        rateLimiting:
          type: object
          additionalProperties: false
          required:
            - enabled
            - store
          properties:
            enabled:
              type: boolean
            store:
              type: string
              enum:
                - memory
                - shared
    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
  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.

````