Read an event filter
GET /v1/event-filters/{filter_id}
Property Value Operation get_event_filterGroup Events Scope webhooks:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; a filter holds ids and labels, never content. Released in 1.52.0 Phase 0 host Served (the hosted api pins 1.65.0)
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:read scope (Authentication and keys ). Replace each placeholder, such as agt_... or <name>, with your own value.
cURL Node.js Python
curl "$VOCAL_API/v1/event-filters/evf_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/event-filters/evf_...`, {
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/event-filters/evf_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Parameters
Name In Type Required Description filter_idpath EventFilterId yes The id of an event filter: evf_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is EventFilter .
Field Type Required Description agent_idsarray of AgentId yes Events whose Call, or Agent version, belongs to one of these Agents. created_atTimestamp yes environmentsarray of Environment yes The environments to match; empty matches both, as livemode stays in the envelope. idEventFilterId yes namestring yes object"event_filter"yes phone_number_idsarray of PhoneNumberId yes Events of Calls on one of these Phone numbers. revisioninteger yes Counts writes; returned as the ETag and required in If-Match. tagsarray of CallTag yes Events of Calls carrying any of these tags, which a pre-call hook sets. trace_typesarray of TraceEventType yes The trace types a call.trace.ready keeps; empty keeps every one. updated_atTimestamp yes