Skip to main content
GET
Get phone number

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

id
string
required

Response

200 - application/json

Successful response

id
string

Phone number assignment ID

phoneNumber
string

Phone number

friendlyName
string

Display name

agentId
string

Assigned agent ID

status
enum<string>
Available options:
ACTIVE,
INACTIVE
createdAt
string<date-time>
agent
object

An agent as returned by the API.

Note the asymmetry with the create/update payloads: you write configuration under config, and read it back under standardConfig (or customProvider). The type field tells you which one is present.