API referenceCoordinator
API reference
Get a plan
Have a token? Manage tokens in the console
GET
One plan with its items and their notes. A plan you cannot see answers not found.
Needs scope coordinator:read.
bearerheader
AuthorizationBearer <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.
plan_id*stringThe plan's id, from List plans.
account_id?stringThe account's id: org in GET /v1/me.
iohr.coordinator.v1.GetPlanResponse
application/json- response
iohr.coordinator.v1.GetPlanResponse
items*array<>notes*array<>plan?iohr.coordinator.v1.Plan
SDK
HTTP
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.getPlan("<plan_id>"); 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.
Example Response
{ "items": [ { "ask_id": "string", "body": "string", "claim_fence": "string", "diagram": "string", "doc": "string", "held_until": "string", "holder": "string", "item_id": "string", "kind": "string", "parent": "string", "position": 0, "preview": "string", "prs": [ "string" ], "size": "string", "status": "string", "title": "string", "updated_at": "string", "updated_by": "string", "version": 0 } ], "notes": [ { "author": "string", "body": "string", "created_at": "string", "id": "string", "item_id": "string" } ], "plan": { "access": "string", "created_at": "string", "external_id": "string", "id": "string", "item_count": 0, "owner": "string", "state": "string", "state_reason": "string", "title": "string", "updated_at": "string", "version": 0, "viewers": [ "string" ] }}