Get plan

Get plan

curl --request GET \
  --url https://app.forecastable.com/api/v1/plans/{planId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.forecastable.com/api/v1/plans/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.forecastable.com/api/v1/plans/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.forecastable.com/api/v1/plans/{planId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.forecastable.com/api/v1/plans/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "entityType": "OPPORTUNITY",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "opportunityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyingGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "milestones": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "milestone": {},
      "status": "not_started",
      "sortIndex": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "objective": {},
      "targetDate": "2023-12-25",
      "actualDate": "2023-12-25",
      "prospectOwnerIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "subscriberOwnerIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "tasks": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "completed": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "completedAt": "2023-11-07T05:31:56Z",
          "targetDate": "2023-12-25",
          "assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "goals": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "goalType": "MILESTONE_BASED",
          "createdAt": "2023-11-07T05:31:56Z",
          "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "target": 123,
          "actualValue": 123,
          "unitType": "NUMBER",
          "label": "<string>",
          "progress": 123,
          "goalTypeCategory": "<string>",
          "targetDate": "2023-12-25",
          "periodType": "QUARTERLY",
          "periodLabel": "<string>",
          "allocations": {},
          "parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childGoals": "<array>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "goalType": "MILESTONE_BASED",
      "createdAt": "2023-11-07T05:31:56Z",
      "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "target": 123,
      "actualValue": 123,
      "unitType": "NUMBER",
      "label": "<string>",
      "progress": 123,
      "goalTypeCategory": "<string>",
      "targetDate": "2023-12-25",
      "periodType": "QUARTERLY",
      "periodLabel": "<string>",
      "allocations": {},
      "parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "childGoals": "<array>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "completed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "completedAt": "2023-11-07T05:31:56Z",
      "targetDate": "2023-12-25",
      "assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

GET

plans

{planId}

Get plan

curl --request GET \
  --url https://app.forecastable.com/api/v1/plans/{planId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.forecastable.com/api/v1/plans/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.forecastable.com/api/v1/plans/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.forecastable.com/api/v1/plans/{planId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.forecastable.com/api/v1/plans/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "entityType": "OPPORTUNITY",
  "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "opportunityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "buyingGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "milestones": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "milestone": {},
      "status": "not_started",
      "sortIndex": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "objective": {},
      "targetDate": "2023-12-25",
      "actualDate": "2023-12-25",
      "prospectOwnerIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "subscriberOwnerIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "tasks": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "completed": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "completedAt": "2023-11-07T05:31:56Z",
          "targetDate": "2023-12-25",
          "assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "goals": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "goalType": "MILESTONE_BASED",
          "createdAt": "2023-11-07T05:31:56Z",
          "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "description": "<string>",
          "target": 123,
          "actualValue": 123,
          "unitType": "NUMBER",
          "label": "<string>",
          "progress": 123,
          "goalTypeCategory": "<string>",
          "targetDate": "2023-12-25",
          "periodType": "QUARTERLY",
          "periodLabel": "<string>",
          "allocations": {},
          "parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "childGoals": "<array>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "goals": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "goalType": "MILESTONE_BASED",
      "createdAt": "2023-11-07T05:31:56Z",
      "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "target": 123,
      "actualValue": 123,
      "unitType": "NUMBER",
      "label": "<string>",
      "progress": 123,
      "goalTypeCategory": "<string>",
      "targetDate": "2023-12-25",
      "periodType": "QUARTERLY",
      "periodLabel": "<string>",
      "allocations": {},
      "parentGoalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "childGoals": "<array>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "completed": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "milestoneId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "completedAt": "2023-11-07T05:31:56Z",
      "targetDate": "2023-12-25",
      "assignedToId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

FlowAuthorization Code

Authorization URL: /api/v1/oauth/authorize
Token URL: /api/v1/oauth/token

FlowClient Credentials

Token URL: /api/v1/oauth/token

Scopes1

plans:read

Read partner plans.

Headers

X-Organization-Id

string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

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}$

Path Parameters

planId

string<uuid>

required

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}$

Query Parameters

organizationId

string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

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}$

Response

Plan detail.

string<uuid>

required

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}$

name

string

required

entityType

enum<string>

required

Plan owner type. ACCOUNT is an account-level plan owned by the account itself (one active plan per account). BUYING_GROUP and OPPORTUNITY plans hang off those entities. USER is a personal ("My Plan") plan owned by a user in the organization.

Available options:

OPPORTUNITY,

BUYING_GROUP,

USER,

ACCOUNT

entityId

string<uuid>

required

Owner entity id. For ACCOUNT plans the account id (same as accountId); for USER plans the plan owner user id (same as userId).

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}$

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

description

string | null

opportunityId

string<uuid> | null

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}$

buyingGroupId

string<uuid> | null

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}$

userId

string<uuid> | null

Personal plan owner user id when entityType is USER.

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}$

accountId

string<uuid> | null

Owning account id when entityType is ACCOUNT.

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}$

milestones

object[]

Show child attributes

goals

object[]

Show child attributes

tasks

object[]

Show child attributes

Meta

Organizations

Accounts

Contacts

Opportunities

Leads

Relationship Maps

Plans

Milestones

Goals

Tasks

Calendar

Engage Templates

Engage Drafts

Engage Lists

Engage Campaigns

Engage Queue

Engage Messaging

Authorizations

Headers

Path Parameters

Query Parameters

Response