Sign in
Docs
API referenceCoordinator

API reference

List plans

Have a token? Manage tokens in the console
GET
/v1/coordinator/plans

The plans you can see, newest change first: the ones you own or were given access to, and every plan of the account if you are an owner or admin of it.

Needs scope coordinator:read.

Authorization

bearer
headerAuthorizationBearer <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.

Query Parameters

state?string

active, paused or archived, or empty for all.

page_size?integer

At most this many; 0 means 50, above 200 means 200.

Formatint32
page_token?string

From the previous page's next_page_token.

account_id?string

The account's id: org in GET /v1/me.

Response Body

iohr.coordinator.v1.ListPlansResponse

application/json
  1. response

iohr.coordinator.v1.ListPlansResponse

next_page_token*string
plans*array<>
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try {  for await (const coordinatorPlan of api.coordinator.allListPlans()) {    console.log(coordinatorPlan);  }} 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
{  "next_page_token": "string",  "plans": [    {      "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"      ]    }  ]}