Skip to main content
GET
/
cases
/
count
Count Cases
curl --request GET \
  --url https://connect.penbox.io/v1/cases/count \
  --header 'Authorization: Bearer <token>'
{
  "count": 123
}
Get the total count of cases matching your filter criteria.

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
​
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

​
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.

Response

200 - application/json

Successful response

​
count
integer

Total number of cases