Skip to main content
GET
/
case_templates
List Case Templates
curl --request GET \
  --url https://connect.penbox.io/v1/case_templates \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total_count": 50,
    "total_pages": 5,
    "page_size": 10,
    "current_page": 1
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "parent_status": "draft",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "locale": "<string>",
      "reference": "<string>",
      "status": "<string>",
      "waiting_for": "none",
      "archived_at": "2023-11-07T05:31:56Z",
      "contacts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "<string>",
          "name": "<string>",
          "email": "[email protected]",
          "given_name": "<string>",
          "family_name": "<string>",
          "phone": "<string>"
        }
      ],
      "template": "<string>",
      "owner": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "given_name": "<string>",
        "family_name": "<string>"
      }
    }
  ]
}
Retrieve a paginated list of case templates with optional filtering and sorting.
Case templates are reusable workflow blueprints that can be instantiated into actual cases.
Use the title filter to search for templates by name with case-insensitive partial matching. This makes it easy to find the right template quickly.

​
Common Use Cases

  • List all available case templates in a workspace
  • Search for templates by title
  • Filter templates by owner or workspace
  • Find archived vs active templates

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
title
string

Filter by case template title (case-insensitive partial match)

​
reference
string

Filter by custom reference number

​
archived
boolean
default:false

Filter by archived status

​
owner[id]
string<uuid>

Filter by owner UUID

​
owner[email]
string<email>

Filter by owner email

​
workspace[id]
string<uuid>

Filter by workspace UUID

​
workspace[slug]
string

Filter by workspace slug

​
contact[given_name]
string

Filter by contact first name

​
contact[family_name]
string

Filter by contact last name

​
contact[email]
string<email>

Filter by contact email

​
filter
string

Filter using advanced JSON syntax. If specified, will ignore all other filter parameters. See the Advanced Filters guide for more information.

​
page[number]
integer
default:1

Page number (starts at 1)

Required range: x >= 1
​
page[size]
integer
default:10

Number of items per page (max: 100)

Required range: 1 <= x <= 100
​
sort
string
default:-created_at

Sort field (prefix with - for descending)

Response

200 - application/json

Successful response

​
meta
object
​
data
object[]