Get Case Template
Retrieve complete details of a specific case template including its steps and schema.
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-readablelabelandparent_status
Authorizations
API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}
Path Parameters
Case Template UUID
Response
Successful response
A reusable case blueprint. Every case created from it inherits its statuses, its contact slots and its data schema.
Case template UUID
Case template title
Creation timestamp
Last update timestamp
Workspace the case template belongs to
Case template description
Language cases created from this template are run in, unless the case overrides it
Custom reference number
Custom statuses configured on this template. Cases created from it inherit them. Null when none is configured.
Contacts already attached to the template, if any
Default owner of the cases created from this template
Steps that make up the case, in order. Use a step key to start it with the Start Case Step endpoint.
Contact slots the template expects. The key of a slot is what you pass in contacts[].key when creating a case.
Data fields defined by the template, with their default values