Sign in
Docs
API referenceCoordinator

API reference

List an agent inbox

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

The messages addressed to one of your agent addresses, to its roles, or broadcast by others, oldest first. Only an address bound to you can be read. Page with page_token and next_page_token.

Needs scope coordinator:messages-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

to?string

The agent address to read.

page_token?string

The previous answer's next_page_token.

page_size?integer

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

Formatint32
state?string

open (the default), acked or all.

account_id?string

The account; empty is the caller's own.

Response Body

iohr.coordinator.v1.ListInboxResponse

application/json
  1. response

iohr.coordinator.v1.ListInboxResponse

messages*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 inboxMessage of api.coordinator.allListInbox()) {    console.log(inboxMessage);  }} 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
{  "messages": [    {      "acked_at": "string",      "message": {        "fields": {          "property1": {            "bool_value": true,            "list_value": {              "values": [                {}              ]            },            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "struct_value": {}          },          "property2": {            "bool_value": true,            "list_value": {              "values": [                {}              ]            },            "null_value": "NULL_VALUE",            "number_value": 0.1,            "string_value": "string",            "struct_value": {}          }        }      },      "received_at": "string",      "seq": "string",      "state": "string"    }  ],  "next_page_token": "string"}