APIHub
Back to Explore

Audit API

The Audit API provides endpoints to list audit events with filtering and pagination, retrieve the available event types, and fetch details of a specific audit event by its UUID.

Uncategorized
basic
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

562ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/events

Retrieve audit events

  • event_type (query) — Filter results by this event type.
  • date_from (query) — Start of time range for audit events. DateTime in ISO-8601 format.
  • date_to (query) — End of time range for audit events. DateTime in ISO-8601 format.
  • search_text (query) — Return only audit events where the JSON object contains this search text. Must be legal text for a JSON attribute value, that is quotes and braces must be escaped.
  • page (query, page) — Page number starting with page 1.
  • size (query, limit) — Number of elements per page.
OPTIONS

/events

Retrieve audit event types

GET

/events/{id}

Retrieve individual audit event

  • id (path, required) — The UUID of the audit event to retrieve

3 endpoints auto-detected

Authentication

This API uses Basic authentication (a username and password).

curl -X GET \
  "https://api.nexmo.com/beta/audit/events"

api.nexmo.com · HTTPS only