Skip to main content
GET
Get Phone Number Details
Read only Returns the stored record for a single phone number: country_iso (the country calling code without a plus, for example 91) and phone_number (the national number as a string of digits, for example 9876543210; the E.164 form is + followed by both), its status, the telephony_provider_id, the inbound_agent_id and outbound_agent_id it is linked to (inbound calls run on that agent’s latest published version), the rental window (rental_start_date, rental_end_date, rental_status), whether a SIP trunk is linked, the dashboard nickname, and created_at. Rental pricing is not part of this record; see Phone Number Pricing.

When to use this

  • Number management UIs: render the per-number detail view in a phone-number management page.
  • Routing audits: verify which agent is currently handling inbound calls on a specific number before making changes.
  • Rental tracking: read rental_start_date, rental_end_date and rental_status to see when a rented number comes up for renewal.
  • Compliance reviews: confirm the number’s country calling code (country_iso) and provider match the use case it is being used for.
For the entire portfolio of numbers on the workspace, use List Phone Numbers.

Path parameters

Errors

  • 404 Not Found is returned when the number does not exist on this workspace. A number that belongs to another workspace is reported the same way.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Phone number ID

Example:

"phn_mfk3p8z2c4v6bn"

Response

Phone number returned successfully.

success
enum<boolean>
required
Available options:
true
error
enum<boolean>
required
Available options:
false
statusCode
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object
required

A phone number owned by the workspace, as stored. Returned by the list and get endpoints.

timestamp
string<date-time>
required