Get an agent plan and its spawned run lanes

GET

/agents/plans/{id}

const url = 'https://example.com/api/agents/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <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/agents/plans/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerApiKey
cookieAuth

Parameters

Path Parameters

required

string format: uuid

Responses

200

Plan snapshot

application/json

object

plan

required

object

required

string format: uuid

project_id

required

string format: uuid

billing_account_id

required

string format: uuid

milestone_id

required

string format: uuid

created_by_user_id

string | null format: uuid

title

required

string

status

required

string

Allowed values: pending approved rejected

source_ticket_ids

required

Array<string>

lanes

required

Array<object>

object

laneKey

required

string

title

required

string

role

required

string

Allowed values: frontend backend test design devops qa other

ticketIds

required

Array<string>

rejection_reason

string | null

approved_at

string | null format: date-time

rejected_at

string | null format: date-time

created_at

required

string format: date-time

updated_at

required

string format: date-time

runs

required

Array<object>

object

required

string format: uuid

plan_id

required

string format: uuid

project_id

required

string format: uuid

billing_account_id

required

string format: uuid

milestone_id

required

string format: uuid

lane_key

required

string

title

required

string

role

required

string

Allowed values: frontend backend test design devops qa other

ticket_ids

required

Array<string>

state

required

string

Allowed values: queued claimed running paused shipping shipped failed released

phase

string | null

worker_id

Identity of the worker holding the claim (null until claimed).

string | null

claimed_at

string | null format: date-time

lease_expires_at

Claim lease deadline; reclaimed if a heartbeat does not renew it.

string | null format: date-time

last_heartbeat

string | null format: date-time

started_at

string | null format: date-time

finished_at

string | null format: date-time

worktree_path

string | null

branch

string | null

pr_url

string | null

last_log_line

string | null

created_at

required

string format: date-time

updated_at

required

string format: date-time

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

Not found

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

500

Server error

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