List the event log

GET /v1/events

Pages the Organization's record events of the last 30 days (a target), newest first by sequence, for the environment of the credential. types, families and filter_id select as a subscription does (types OR families, narrowed by the filter), and created_after and created_before bound the range. The payloads are built under the Organization's PHI mode at read time, as a delivery's are.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the events:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/events" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/events`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/events",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is EventList.