Skip to main content
GET
/
cases
Error
A valid request URL is required to generate request examples
{
  "data": {
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "referenceNumber": "ABC-0001",
        "title": "<string>",
        "description": "<string>",
        "status": "<string>",
        "caseType": "<string>",
        "jurisdiction": "<string>",
        "county": "<string>",
        "clientFirstName": "<string>",
        "clientLastName": "<string>",
        "clientEmail": "jsmith@example.com",
        "clientPhone": "<string>",
        "incidentDate": "2023-12-25",
        "notes": "<string>",
        "sendingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "receivingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "total": 123,
    "page": 123,
    "limit": 123
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key
string
header
required

Public API key (starts with cxp_). Required on every request.

Query Parameters

page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
limit
integer
default:20

Results per page (max 100)

Required range: 1 <= x <= 100
status
string

Filter by CaseStatus enum value

Keyword search across title, reference number, client name

dateFrom
string<date>
dateTo
string<date>
view
enum<string>

Perspective filter (default: all)

Available options:
sent,
received,
all
sort
string
order
enum<string>
Available options:
asc,
desc

Response

Paginated list of cases

data
object
required
meta
object
required