Get Case
Retrieve complete details of a specific case including its steps and schema.
status field contains the key of the status, not its label. Use status_label to display it directly, or the statuses array — returned with the case — to map every key to its label. Neither requires an extra call.Custom statuses return the label configured on the case template. Built-in statuses (draft, pending, in_progress, closed, cancelled) return an English label: translate them from the key if you need another language.actor_type says who decided: human a person, ai a model, automation a rule configured on a case template, partner a partner integration, system Penbox itself or an API token. channel says which surface the case came through: app, outlook, mcp, api, email, form, connection or system. creator is the workspace member who created the case, or null when no person did.You cannot write these fields. A value sent in a request body is ignored. They are null on cases created before this was recorded.Authorizations
API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}
Path Parameters
Case UUID
Response
Successful response
Case UUID
Case title
Parent status
draft, pending, in_progress, closed, cancelled Creation timestamp
Last update timestamp
Workspace the case belongs to
Case description
Language/locale code
Custom reference number
Key of the current status
Human-readable label of the current status. Custom statuses return the label configured on the case template, in the language it was written in. Built-in statuses (draft, pending, in_progress, closed, cancelled) return an English label, as the API has no notion of the reader's language.
"Waiting for documents"
Who the case is waiting for
none, owner, contact Statuses available on this case, inherited from its case template. Use it to resolve the status key into a readable label. Null when no status is configured.
Timestamp when archived
Array of contact objects
Template reference
Case owner information
Who decided to create the case: human a person, ai a model, automation a rule configured on a case template, partner a partner integration, system Penbox itself or an API token. Read-only, and null on cases created before this was recorded.
human, ai, automation, partner, system The surface the case came through: the Penbox app, the Outlook add-in, an AI assistant, this API, an email, a completed form, a connection or Penbox itself. Read-only, and null on cases created before this was recorded.
app, outlook, mcp, api, email, form, connection, system The workspace member who created the case. Null when no person created it, and null on cases created before this was recorded. Read-only.
Array of step objects representing the case workflow
Array of data fields with their current values