Skip to main content
GET
/
v1
/
alerts
List alerts
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/alerts \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "alt_3j7k9m2n",
      "case_token": "<string>",
      "entity_token": "<string>",
      "type": "Identity",
      "category": "PEP Match",
      "status": "Open",
      "priority": "Critical",
      "priority_score": 50,
      "sla_deadline": "2023-11-07T05:31:56Z",
      "sla_status": "On Track",
      "match_score": 50,
      "ai_assessment": "<string>",
      "resolution_action": "Approve",
      "resolution_rationale": "<string>",
      "resolved_by": "<string>",
      "resolved_at": "2023-11-07T05:31:56Z",
      "assigned_to": "<string>",
      "is_false_positive": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_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 alert status.

Available options:
Open,
Acknowledged,
Resolved,
False Positive,
Escalated
​
type
enum<string>

Filter by alert type.

Available options:
Identity,
Screening,
Company,
Document,
Financial,
Client Input,
Internal Review
​
category
string

Filter by alert category.

​
priority
enum<string>

Filter by priority level.

Available options:
Critical,
High,
Medium,
Low
​
case_token
string

Filter by case.

​
entity_token
string

Filter by entity.

Response

List of alerts.

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

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object