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
  • Statuses: The custom statuses configured in the template, each with its key, human-readable label and parent_status
Cases created from this template inherit these statuses and return them in their own statuses array, so resolving a case status key into a label does not require fetching 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

A reusable case blueprint. Every case created from it inherits its statuses, its contact slots and its data schema.

id
string<uuid>
required

Case template UUID

title
string
required

Case template title

created_at
string<date-time>

Creation timestamp

updated_at
string<date-time>

Last update timestamp

workspace
object

Workspace the case template belongs to

description
string | null

Case template description

locale
string | null

Language cases created from this template are run in, unless the case overrides it

reference
string | null

Custom reference number

statuses
object[] | null

Custom statuses configured on this template. Cases created from it inherit them. Null when none is configured.

contacts
object[]

Contacts already attached to the template, if any

owner
object | null

Default owner of the cases created from this template

steps
object[]

Steps that make up the case, in order. Use a step key to start it with the Start Case Step endpoint.

contacts_schema
object[]

Contact slots the template expects. The key of a slot is what you pass in contacts[].key when creating a case.

schema
object[]

Data fields defined by the template, with their default values