API referenceCases
API reference
List the shares of a client case
Have a token? Manage tokens in the console
GET
The grants on a client case, to a customer organisation or named people, with expiry and whether revoked.
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.
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.ListSharesResponse
application/json- response
iohr.cases.v1.ListSharesResponse
next_page_token*stringshares*array<>SDK
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 share of api.cases.allListShares("<case_id>")) { console.log(share); }} 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
{ "next_page_token": "string", "shares": [ { "case_id": "string", "expires_at": "string", "granted_at": "string", "granted_by": "string", "grantee": "string", "grantee_kind": "string", "revoked_at": "string", "revoked_by": "string", "share_id": "string", "state": "string" } ]}