Get Phone Number

Fetch the full record of a single phone number in your account, including capabilities, assigned agent, and rental status.

GET /organization-phone-numbers/{id}

Get a phone number

cURL

curl --request GET \
  --url https://api.dialnexa.com/v1/organization-phone-numbers/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "phn_abc123",
  "phone_number": "[phone]",
  "label": "Main Support Line",
  "agent_id": "agt_abc123",
  "status": "active",
  "provider": "twilio",
  "created_at": "2024-03-01T10:00:00.000Z",
  "nickname": "Sales Line"
}

Returns the full record for a single purchased phone number: the E.164 phone_number, the country_code, the type (local, toll-free, or mobile), the monthly rental cost, the supported capabilities (voice, SMS where available), the display nickname, the currently assigned inbound_agent_id, and the purchase timestamp.

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.
• Cost attribution: pull monthly_cost_usd to attribute telephony spend per workspace or per use case in internal reports.
• Compliance reviews: confirm the number’s country and capabilities match the use case it is being used for.

For the entire portfolio of numbers on the workspace, use List Phone Numbers.

Path parameters

Parameter	Description
id	The phone number ID, for example phn_f7w2kx5mb9qz.

Errors

• 404 Not Found is returned when the number does not exist on this workspace.
• 403 Forbidden is returned when the API key cannot read phone number records.

Request

curl "https://api.dialnexa.com/v1/organization-phone-numbers/phn_f7w2kx5mb9qz" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

{
  "id": "phn_f7w2kx5mb9qz",
  "phone_number": "[phone]",
  "country_code": "IN",
  "type": "local",
  "monthly_cost_usd": "1.15",
  "capabilities": ["voice"],
  "nickname": "Mumbai Support",
  "inbound_agent_id": "agt_k7m2nq9xw4p8",
  "created_at": "2024-01-15T07:00:00.000Z"
}

Related endpoints

• List Phone Numbers: see every number on the workspace.
• Update Phone Number: change the nickname or reassign the inbound agent.
• Release a Number: release a number back to the provider’s pool.
• Buy a Phone Number: purchase a new number.

Authorizations

Authorization · string · header · required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id · string · required

Response

200

application/json

Success.

id · string

Example:

"phn_abc123"

phone_number · string

Example:

"[phone]"

label · string | null

Example:

"Main Support Line"

agent_id · string | null

Example:

"agt_abc123"

status · enum<string>

Phone number provisioning status.

Available options: pending, active

Example:

"active"

provider · string

Example:

"twilio"

created_at · string<date-time>

Example:

"2024-03-01T10:00:00.000Z"

nickname · string | null

Human-readable nickname shown in dashboard selectors and phone number tables.

Maximum string length: 255

Example:

"Sales Line"