Docs
Have a token? Manage tokens in the console
GET
/v1/rfcs/spaces/{space_id}/documents/{document_id}/comments

A document's comment threads, each anchored to a section, with replies. status is open or resolved.

Needs scope rfc:read.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.

Path Parameters

space_id*string

The space's id, lab_ and a ULID, from List spaces.

document_id*string

The document's id, ldoc_ and a ULID, from List documents.

Query Parameters

status?string

open or resolved; 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.rfcs.v1.ListCommentsResponse

application/json
  1. response

iohr.rfcs.v1.ListCommentsResponse

comments*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 comment of api.rfcs.allListComments("<space_id>", "<document_id>")) {    console.log(comment);  }} catch (e) {  if (!(e instanceof ApiError)) throw e;  console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}

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.

{  "comments": [    {      "anchor": "string",      "author": "string",      "body": "string",      "comment_id": "string",      "created_at": "string",      "document_id": "string",      "parent_id": "string",      "quote": {        "exact": "string",        "prefix": "string",        "start": 0,        "suffix": "string"      },      "resolved": true,      "resolved_at": "string",      "resolved_by": "string",      "version": 0    }  ],  "next_page_token": "string"}