API referenceCases
API reference
List client cases
Have a token? Manage tokens in the console
GET
The account's client cases, a page at a time: the versions of a study that may be shown to a customer, each with its current and published version. Enterprise accounts only.
Needs scope cases:read.
bearerheader
AuthorizationBearer <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.
page_size?integerAt most this many; 0 means 50, above 200 means 200.
Format
int32page_token?stringFrom the previous page's next_page_token.
iohr.cases.v1.ListClientCasesResponse
application/json- response
iohr.cases.v1.ListClientCasesResponse
client_cases*array<>next_page_token*stringSDK
HTTP
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 clientCase of api.cases.allListClientCases()) { console.log(clientCase); }} 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
{ "client_cases": [ { "case_id": "string", "company": "string", "created_at": "string", "created_by": "string", "current_version": 0, "plan_id": "string", "published_version": 0, "slug": "string", "status": "string", "study_id": "string", "text": { "en": { "markdown": "string", "summary": "string", "title": "string" }, "hr": { "markdown": "string", "summary": "string", "title": "string" } }, "updated_at": "string" } ], "next_page_token": "string"}