Sign in
Docs
API referenceSchedules

API reference

A schedule's timeline

Have a token? Manage tokens in the console
GET
/v1/schedules/{schedule_id}/timeline

Who covers between two instants (at most 31 days), as consecutive spans.

Needs scope schedules: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.

Path Parameters

schedule_id*string

The schedule.

Query Parameters

account_id?string

A team you belong to; empty for your own account.

start?string

An RFC 3339 time.

end?string

An RFC 3339 time, after the start.

Response Body

iohr.schedules.v1.TimelineResponse

application/json
  1. response

iohr.schedules.v1.TimelineResponse

spans*array<>
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.schedules.timeline("<schedule_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
{  "spans": [    {      "end": "string",      "layer_id": "string",      "override_id": "string",      "responder": {        "id": "string",        "kind": "string"      },      "scope": [        "string"      ],      "source": "string",      "start": "string"    }  ]}