Skip to main content
GET
/
v1
/
audit-logs
List audit logs
curl --request GET \
  --url https://instance.prod.onboardapp.io/v1/audit-logs \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "token": "aud_4t8u2v6w",
      "event_type": "<string>",
      "actor": {
        "user_id": "<string>",
        "name": "<string>",
        "type": "user"
      },
      "target_type": "case",
      "target_token": "<string>",
      "details": {},
      "ip_address": "<string>",
      "created_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
​
event_type
string

Filter by event type (e.g., case.created, alert.resolved).

​
actor
string

Filter by actor user ID.

​
target_type
enum<string>

Filter by target resource type.

Available options:
case,
alert,
check,
entity,
risk_assessment
​
target_token
string

Filter by target resource token.

​
from
string<date-time>

Start date filter (ISO 8601).

​
to
string<date-time>

End date filter (ISO 8601).

Response

List of audit log entries.

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

​
data
object[]

Response payload. Type varies by endpoint.

​
meta
object