Skip to main content
GET
Count Cases
Get the total count of cases matching your filter criteria.
This endpoint accepts the same filters as List Cases, including the free-text contact[search], so a count always matches the list it belongs to:

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

template[id]
string<uuid>

Filter by template UUID

status
string

Filter by custom status

parent_status
enum<string>

Filter by parent status

Available options:
draft,
pending,
in_progress,
closed,
cancelled
archived
boolean
default:false

Filter by archived status

waiting_for
enum<string>

Filter by who the case is waiting for

Available options:
none,
owner,
contact
reference
string

Filter by custom reference number

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. Exact match, case-sensitive and accent-sensitive — use contact[search] for partial, case-insensitive or accent-insensitive matching.

contact[family_name]
string

Filter by contact last name. Exact match, case-sensitive and accent-sensitive — use contact[search] for partial, case-insensitive or accent-insensitive matching.

contact[email]
string<email>

Filter by contact email. Exact match — use contact[search] to match on a fragment of the address.

Free-text search over the case's contacts. Returns cases having at least one contact that matches.

The query is split on spaces and every word must match, anywhere in the contact and in any order — so Mélanie Hardy, hardy mel and Hardy Mélanie all find the same person. Matching is case-insensitive and accent-insensitive in both directions (Melanie finds Mélanie, Jorgensen finds Jørgensen).

Searched fields: first name, last name, email, phone number, internal reference and company name. A fragment is enough — 112233 matches the phone +32470112233.

% and _ are matched literally, not as wildcards.

Combine it with contact[given_name], contact[email], or any case-level filter: all conditions must hold.

An empty value applies no filter, so a cleared search box can keep sending the parameter.

Limits: at most 128 characters and at most 6 words. Exceeding either returns 422 Unprocessable Entity.

Maximum string length: 128
filter
string

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

Response

200 - application/json

Successful response

count
integer

Total number of cases