API referenceCoordinator
API reference
Create a plan
Have a token? Manage tokens in the console
POST
Create a plan with a title (1 to 200 characters) you own. It starts with no items.
Needs scope coordinator:write.
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.
iohr.coordinator.v1.CreatePlanRequest; path variables override their fields
application/json- body
iohr.coordinator.v1.CreatePlanRequest
access?stringaccount_id?stringexternal_id?stringtitle?stringviewers?array<string>iohr.coordinator.v1.CreatePlanResponse
application/json- response
iohr.coordinator.v1.CreatePlanResponse
created*booleanplan?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.createPlan({ access: "<access>", title: "<title>", viewers: ["<viewers>"], }); 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
{ "created": true, "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" ] }}