Read a project's plan back as the JSON sync-plan accepts

GET

/board/plan

const url = 'https://example.com/api/board/plan?project_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {cookie: 'sb-access-token=<sb-access-token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/board/plan?project_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --cookie sb-access-token=<sb-access-token>

With plan_key, returns { plan } — the plan document (program, milestones, tickets) rebuilt from the live board, in exactly the shape POST /board/sync-plan takes, so a second edit is GET → change one ticket → POST. Stage, status and progress are excluded by design. Without plan_key, returns { plans }: every plan key on the project with its program name and live milestone/ticket counts. Archived milestones and tickets are excluded from both.

Authorizations

cookieAuth

Parameters

Query Parameters

project_id

required

string format: uuid

plan_key

string

>= 1 characters

Omit to list the project’s plan keys instead of reading one plan.

Responses

200

The plan document, or the project’s plan listing

application/json

One of:

object
object

object

plan

required

Plan document — the same shape sync-plan accepts.

object

key

additional properties

any

400

Invalid request

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

404

No plan with that key on this project

application/json

object

error

required

string

code

required

string

Allowed values: PLAN_NOT_FOUND

429

Rate limited

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

retryAfter

Seconds until the rate limit resets

number

Headers

Retry-After

string