API referenceCases
API reference
Open a shared case
Have a token? Manage tokens in the console
GET
For a signed-in customer: the published version of a client case shared with them, with the frozen plan in customer form. Records who opened which version.
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.OpenSharedCaseResponse
application/json- response
iohr.cases.v1.OpenSharedCaseResponse
client_case?iohr.cases.v1.ClientCase
items*array<>plan_unavailable*booleantimeline*array<>version*integerFormat
int32SDK
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.openSharedCase("<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" }, "items": [ { "proof_links": [ "string" ], "status": "string", "title": "string" } ], "plan_unavailable": true, "timeline": [ { "at": "string", "item_title": "string", "label": "string" } ], "version": 0}