Skip to main content
GET
Get Case credential context

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Response

company
string<uuid>
required

Company whose data the request is authorized to access.

environment
enum<string>
required

Environment in which the credential is being used.

  • production - production
  • sandbox - sandbox
Available options:
production,
sandbox
id
string<uuid> | null
required

Stable identifier of the calling credential, when available.

scopes
string[]
required

Permissions granted to the calling credential.

token_name
string | null
required

Human-readable name assigned to the calling credential.