Sign in
Docs
API referenceDecisions

API reference

List work

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

An account's work items, the latest change first: everything but done, unless a state is asked for.

Needs scope decisions: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

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

space_id?string

Only this space's.

document_id?string

Only this document's.

state?string

open, claimed, in_progress, blocked or done; empty for all but done.

claimed_by?string

Only what this agent or person holds, as they name themselves.

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.work.v1.ListResponse

application/json
  1. response

iohr.work.v1.ListResponse

items*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 workWorkItem of api.work.allList()) {    console.log(workWorkItem);  }} 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": [    {      "account_id": "string",      "claimed_by": "string",      "claimed_via": "string",      "created_at": "string",      "created_by": "string",      "document_id": "string",      "handed_to": "string",      "handoff": "string",      "item_id": "string",      "links": [        "string"      ],      "notes": "string",      "space_id": "string",      "state": "string",      "title": "string",      "updated_at": "string",      "updated_by": "string"    }  ],  "next_page_token": "string"}