Skip to main content
GET
/
v1
/
cases
List cases
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/cases \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "cas_9k4m2n1p",
      "name": "CAS-000142",
      "type": "Onboarding",
      "status": "New",
      "entity_category": "Company",
      "assigned_to": "<string>",
      "sla_deadline": "2023-11-07T05:31:56Z",
      "sla_status": "On Track",
      "open_alerts_count": 123,
      "total_entities_count": 123,
      "risk_tier": "High",
      "risk_score": 123,
      "decision": "Approve",
      "external_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "closed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "request_id": "req_9k4m2n1p3q",
    "page": {
      "cursor": "<string>",
      "has_more": true
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Project-scoped API key for server-to-server authentication. Obtain keys from the Zenoo dashboard under Project Settings > API Keys. Staging and production environments use separate keys.

Query Parameters

​
cursor
string

Pagination cursor from a previous response. Pass to fetch the next page.

​
limit
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by case status.

Available options:
New,
In Progress,
In Review,
Internal Review,
Client Input,
Closed,
Escalated
​
type
enum<string>

Filter by case type.

Available options:
Onboarding,
Review,
Perpetual
​
entity_category
enum<string>

Filter by entity category.

Available options:
Company,
Person
​
risk_tier
enum<string>

Filter by risk tier.

Available options:
High,
Medium,
Low
​
assigned_to
string

Filter by assigned reviewer user ID.

Response

List of cases.

Standard response wrapper for all API endpoints. Contains the resource data and pagination metadata.

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object