v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Case Management

Count cases

Returns case counts, optionally grouped by one or more fields (for example, status, priority). Supports a query filter to narrow the scope.

get/api/v2/cases/count

Query parameters

query_filterstring

Filter query for cases.

group_bysstring

Comma-separated fields to group by.

limitinteger

Maximum facet values to return.

Response

Example response

{
  "data": {
    "attributes": {
      "groups": [
        {
          "group": "status",
          "group_values": [
            {
              "count": 42,
              "value": "OPEN"
            }
          ]
        }
      ]
    },
    "id": "count-result-001",
    "type": "count"
  }
}