Skip to main content
GET
Get Agent Phone Number History
Read only Get agent phone number history to audit which numbers an agent has used and when. Each row is one link: a number attached to the agent in one direction, from linked_at until unlinked_at. Rows are ordered newest first.

When to use this

  • Call investigations: find which agent a number routed to at the time of a call.
  • Change audits: see who attached or detached a number and why a link ended.

Before you begin

Get the agent ID from List Agents.

Get agent phone number history request

Read the history rows

Verify the result

A 200 response contains data as an array. An empty array means no link is recorded for the agent.

Errors and recovery

  • 401 Unauthorized means the API key is missing or invalid.
  • 404 Not Found means the agent does not exist in this workspace or was deleted.
Reads are safe to retry.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agentId
string
required

Agent ID from List Agents.

Example:

"agent_2g7Xy3tY53gRlp"

Response

Successful response.

success
boolean
required
error
boolean
required
statusCode
integer
required
message
string
required
data
object[]
required
timestamp
string<date-time>
required