Search caller data
Returns what the platform keeps about a phone number for your organization: the calls where it was the caller or the person called, the outbound contacts with it, and whether it is on the do-not-call list. Only identifiers, dates and booleans: never the content of a call. Use it to answer a person who asks whether you hold data about them, then export or erase. The search is not a request: it is not recorded in the register, so received_at and reference are accepted but not used. Required scope: caller_requests:manage. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing. This is a read that uses POST only so that its input (a phone number, a search text) travels in the body and never in the URL. It takes no Idempotency-Key, nothing is stored, and the response is never cached or repeated.
Authentication
Headers
API version for this request; defaults to the version the key is pinned to.
Request
The phone number of the person, in international format (E.164), for example +393331234567. It travels only in the request body.
When you received the person’s request (ISO 8601). It starts the one-month deadline of GDPR art. 12(3). Default: now. Not earlier than 365 days ago and not in the future.
Your own reference for the request, for example the case number: 1 to 64 letters, digits, dots, underscores, colons or hyphens. It must not be personal data.
Response
Always caller_data_summary.
The do-not-call list of the organization: active is true if this number has objected to being called.