Skip to main content
GET
Get Case
Retrieve complete details of a specific case including its steps and schema.
The 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.

Authorizations

Authorization
string
header
required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Path Parameters

id
string<uuid>
required

Case UUID

Response

200 - application/json

Successful response

id
string<uuid>
required

Case UUID

title
string
required

Case title

parent_status
enum<string>
required

Parent status

Available options:
draft,
pending,
in_progress,
closed,
cancelled
created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

workspace
object

Workspace the case belongs to

description
string | null

Case description

locale
string | null

Language/locale code

reference
string | null

Custom reference number

status
string | null

Key of the current status

status_label
string | null

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.

Example:

"Waiting for documents"

waiting_for
enum<string>

Who the case is waiting for

Available options:
none,
owner,
contact
statuses
object[] | null

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.

archived_at
string<date-time> | null

Timestamp when archived

contacts
object[]

Array of contact objects

template
string | null

Template reference

owner
object | null

Case owner information

steps
object[]

Array of step objects representing the case workflow

schema
object[]

Array of data fields with their current values