Sign in
Docs
API referenceCoordinator

API reference

List watch grants

Have a token? Manage tokens in the console
GET
/v1/coordinator/watch-grants

Who may see the full coordinator picture beyond inorbit.hr accounts and admins, with each grant's note and expiry. Staff only (an admin or a verified inorbit.hr address); a grant holder cannot list grants.

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

account_id?string
state?string

active, revoked, or empty for both.

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.

Response Body

iohr.coordinator.v1.ListWatchGrantsResponse

application/json
  1. response

iohr.coordinator.v1.ListWatchGrantsResponse

grants*array<>
next_page_token*string
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 watchGrant of api.coordinator.allListWatchGrants()) {    console.log(watchGrant);  }} 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
{  "grants": [    {      "active": true,      "expires_at": "string",      "granted_at": "string",      "granted_by": "string",      "grantee": "string",      "grantee_kind": "string",      "id": "string",      "note": "string",      "revoked_at": "string",      "revoked_by": "string"    }  ],  "next_page_token": "string"}