API referenceCases
API reference
Get a client case
Have a token? Manage tokens in the console
GET
One client case with its current version, the published version and the plan it follows.
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.
case_id*stringThe client case's id, cas_ and 32 hex characters, from List client cases.
iohr.cases.v1.GetClientCaseResponse
application/json- response
iohr.cases.v1.GetClientCaseResponse
client_case?iohr.cases.v1.ClientCase
plan_items*array<>plan_unavailable*booleanSDK
HTTP
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.cases.getClientCase("<case_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
{ "client_case": { "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" }, "plan_items": [ { "reason": "string", "ref": "string", "stage": "string", "status": "string", "stub": true } ], "plan_unavailable": true}