Skip to main content
GET
Get Case Template
Retrieve complete details of a specific case template including its steps and schema.
This endpoint returns the full template structure including all configured steps and data schema fields. Use this to understand what a template workflow looks like before creating cases from it.

Response Details

The response includes:
  • Basic template information: title, description, reference, etc.
  • Steps: The complete workflow steps configuration
  • Schema: Data fields and their types that cases created from this template will have
  • Contacts: Contact roles configured in the template

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 Template 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
created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

description
string | null

Case description

locale
string | null

Language/locale code

reference
string | null

Custom reference number

status
string | null

Custom status value

waiting_for
enum<string>

Who the case is waiting for

Available options:
none,
owner,
contact
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