List Phone Numbers

GET

organization-phone-numbers

List Phone Numbers

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/organization-phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/organization-phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/organization-phone-numbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/organization-phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "phn_mfk3p8z2c4v6bn",
        "phone_number": "9876543210",
        "status": "active",
        "country_iso": "91",
        "telephony_provider_id": "mh00mke5j83neo",
        "organization_id": "o14XKPP84rt22g",
        "inbound_agent_id": null,
        "outbound_agent_id": "agent_2g7Xy3tY53gRlp",
        "rental_start_date": "2026-09-17",
        "rental_end_date": "2026-10-17",
        "rental_status": "active",
        "sip_trunk_enabled": false,
        "nickname": null,
        "is_deleted": false,
        "deleted_at": null,
        "deleted_by": null,
        "created_at": "2026-09-17T05:52:18.634Z",
        "updated_at": "2026-09-17T05:52:18.634Z",
        "is_default": true
      }
    ],
    "meta": {
      "currentPage": 1,
      "itemsPerPage": 20,
      "hasMore": false
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

Read only Returns every phone number provisioned in your workspace, paginated. Each entry carries country_iso (the country calling code without a plus, for example 91), phone_number (the national number as a string of digits; 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, the rental window (rental_start_date, rental_end_date, rental_status), whether a SIP trunk is linked, the dashboard nickname, created_at, and is_default (whether it is a DialNexa system default number). The meta object reports the current page, the page size and hasMore; no total count is returned. Use this to power a number management view, audit which numbers are in use, or sync your DialNexa number portfolio with your asset inventory.

When to use this

Number management UIs: render a table of every number with its status, rental window and assigned agents.
Routing audits: confirm every active number has an agent assigned, or surface unrouted numbers as a follow-up task.
Cost reporting: aggregate by calling code (country_iso) or telephony_provider_id to attribute telephony spend per workspace, region, or provider.
Operational scripts: enumerate numbers before auditing routing assignments or provisioning additional numbers.

Query parameters

Parameter	Description
`page`	Page number, starting from 1.
`limit`	Results per page. Minimum `1`. Default: `20`.
`sortBy`	Field to sort by. One of `id`, `created_at`, `updated_at`, `status`. Default: `id`.
`sortOrder`	Sort direction, `ASC` or `DESC` (case-insensitive). Default: `ASC`.

Errors

400 Bad Request is returned when page or limit is below 1 or not a whole number, or sortBy or sortOrder is outside its allowed values.
401 Unauthorized is returned when the API key is missing or invalid.

Get Phone Number Details: fetch a single number’s detail.
Buy a Phone Number: purchase a new number.
Search Available Numbers: find provider numbers available for purchase.
Link SIP Trunk: connect a bring-your-own number.
Delete Phone Number: remove a number you no longer use.
API pagination: how DialNexa list endpoints paginate.

Authorizations

Authorization

string

header

required

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

Query Parameters

page

number

default:1

Page number, starting from 1.

Required range: x >= 1

limit

number

default:20

Results per page.

Required range: x >= 1

sortBy

enum<string>

default:id

Field to sort by.

Available options:

id,

created_at,

updated_at,

status

sortOrder

enum<string>

default:ASC

Sort direction.

Available options:

ASC,

DESC

Response

Phone numbers 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

Show child attributes

timestamp

string<date-time>

required

List Phone Numbers

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/organization-phone-numbers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/organization-phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/organization-phone-numbers"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/organization-phone-numbers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "statusCode": 200,
  "message": "Success",
  "data": {
    "items": [
      {
        "id": "phn_mfk3p8z2c4v6bn",
        "phone_number": "9876543210",
        "status": "active",
        "country_iso": "91",
        "telephony_provider_id": "mh00mke5j83neo",
        "organization_id": "o14XKPP84rt22g",
        "inbound_agent_id": null,
        "outbound_agent_id": "agent_2g7Xy3tY53gRlp",
        "rental_start_date": "2026-09-17",
        "rental_end_date": "2026-10-17",
        "rental_status": "active",
        "sip_trunk_enabled": false,
        "nickname": null,
        "is_deleted": false,
        "deleted_at": null,
        "deleted_by": null,
        "created_at": "2026-09-17T05:52:18.634Z",
        "updated_at": "2026-09-17T05:52:18.634Z",
        "is_default": true
      }
    ],
    "meta": {
      "currentPage": 1,
      "itemsPerPage": 20,
      "hasMore": false
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

Overview

Endpoints

When to use this

Query parameters

Errors

Authorizations

Query Parameters

Response

​When to use this

​Query parameters

​Errors

​Related endpoints

Authorizations

Query Parameters

Response

When to use this

Query parameters

Errors

Related endpoints