Skip to main content
GET
Retrieve a caller

Authorizations

Authorization
string
header
required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Path Parameters

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

Response

The caller

id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

object
enum<string>
required
Available options:
caller
agent_id
string
required
Pattern: ^[0-9a-f]{24}$
Example:

"6a96a3ead6e886d42462dd3e"

kind
enum<string>
required
Available options:
web,
app,
phone
name
string | null
required
email
string | null
required
phone
string | null
required
verified_by
enum<string> | null
required

How the name and contact were learned: a Google sign-in, the Wixzel account the caller was signed in to in the app, or a form the caller filled in (not checked). Null when the caller gave none.

Available options:
google,
app,
form
location
object
required

Where they last called from.

platform
object
required

What they last called on.

page_url
string | null
required
call_count
integer
required
blocked
boolean
required

A blocked caller cannot call this agent again: not from its share link, its website widget, the app, or by phone.

blocked_at
string<date-time> | null
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

first_seen_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

last_seen_at
string<date-time>
required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"