API reference
Get the plans overview
Every plan you can see in one read: per plan its progress (not started, running, waiting on a person, waiting on a pull request, done or failed), the items in each, who or what it waits on, running jobs, pull requests, release stage and stuck items, plus totals and the seq to resume the stream from. A fact that is a stub is marked stub and never counts as merged. The public tier hashes owners and the people a plan waits on.
Needs scope coordinator:read.
bearerAuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
account_id?stringThe account's id: org in GET /v1/me.
team?stringNot supported yet; a value is refused.
state?stringactive, paused or archived; empty is active and paused.
iohr.coordinator.v1.GetPlansOverviewResponse
application/json- response
iohr.coordinator.v1.GetPlansOverviewResponse
generated_at*stringplans*array<>seq*stringint64tier*stringtotals?iohr.coordinator.v1.OverviewTotals
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.coordinator.getPlansOverview(); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "generated_at": "string", "plans": [ { "counts": { "done": 0, "failed": 0, "not_started": 0, "running": 0, "waiting_on_person": 0, "waiting_on_pr": 0 }, "heartbeat_at": "string", "owner": "string", "plan_id": "string", "progress": "string", "prs": [ { "ref": "string", "state": "string", "stub": true } ], "release_stage": "string", "running_jobs": 0, "running_tool": "string", "seq": "string", "state": "string", "stub": true, "stuck": [ "string" ], "team": "string", "title": "string", "updated_at": "string", "waiting_on": { "ask_id": "string", "kind": "string", "ref": "string", "since": "string" } } ], "seq": "string", "tier": "string", "totals": { "by_progress": { "done": 0, "failed": 0, "not_started": 0, "running": 0, "waiting_on_person": 0, "waiting_on_pr": 0 }, "open_prs": 0, "plans": 0, "running_jobs": 0, "stuck": 0, "waiting_on_me": 0 }}