Sign in

v1

latestOpenAPI 3.0.0The MIT License (MIT)2026-07-1431713.1 KB

Retrieve individual audit event

Get the specified audit event.

get/events/{id}

Path parameters

idstring required

The UUID of the audit event to retrieve

Response

OK

account_idstring

The NEXMO_API_KEY of the Vonage API account that the audit event is associated with.

created_atstring date

When the audit event was created.

event_type'USER_STATUS' | 'USER_UPDATE' | 'USER_BILLING_UPDATE' | 'USER_CREATE' | 'USER_LOGIN' | 'USER_LOGOUT' | 'USER_PRODUCT_SEARCH' | 'USER_API_KEYS_UPDATE' | 'ACCOUNT_SECRET_DELETE' | 'ACCOUNT_SECRET_CREATE' | 'ACCOUNT_UPDATE_SPAMMER' | 'ACCOUNT_UPDATE_SETTINGS_API' | 'NUMBER_ASSIGN' | 'NUMBER_UPDATED' | 'NUMBER_RELEASE' | 'NUMBER_LINKED' | 'NUMBER_UNLINKED' | 'APP_CREATE' | 'APP_UPDATE' | 'APP_DELETE' | 'APP_DISABLE' | 'APP_ENABLE' | 'IP_WHITELIST_CREATE' | 'IP_WHITELIST_DELETE' | 'AUTORELOAD_ENABLE' | 'AUTORELOAD_UPDATE' | 'AUTORELOAD_DISABLE'

The type of the audit event.

event_type_descriptionstring

A description of the event type

idstring

UUID of the audit event

source'CD' | 'DEVAPI'

The source of the event. CD: Customer Dashboard DEVAPI: via Developer API

source_countrystring

ISO 3166-1 Alpha-2 country code recorded for the event.

source_description'Customer Dashboard' | 'Developer API' A human readable description of the `source`.

Description of the audit event source.

source_ipstring ipv4

The IP address used to make the account change.

user_emailstring email

Email of the user whose account the audit event is associated with.

user_idinteger

The ID of the user that the audit event is associated with.

Example response

{
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    }
  },
  "account_id": "abcd1234",
  "context": {
    "appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
    "created": {
      "accountId": "abcdef01",
      "answer_url": {
        "method": "GET",
        "url": "https://example.org/my-app-callback"
      },
      "appId": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
      "event_url": {
        "method": "GET",
        "url": "https://example.org/my-app-callback"
      },
      "name": "My Voice App",
      "type": "voice"
    }
  },
  "created_at": "2018-07-04T11:41:32",
  "event_type": "APP_CREATE",
  "event_type_description": "Application created.",
  "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "source": "CD",
  "source_country": "GB",
  "source_description": "Customer Dashboard",
  "source_ip": "192.0.2.0",
  "user_email": "user@example.org",
  "user_id": 1234567
}