List phone numbers (DIDs)

GET

/api/v2/nova/numbers

curl --request GET \
  --url 'https://api.sipstack.com/api/v2/nova/numbers?page=1&limit=50' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sipstack.com/api/v2/nova/numbers"

querystring = {"page":"1","limit":"50"}

headers = {"x-api-key": "<x-api-key>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

const url = 'https://api.sipstack.com/api/v2/nova/numbers?page=1&limit=50';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.sipstack.com/api/v2/nova/numbers',
  params: {page: '1', limit: '50'},
  headers: {'x-api-key': '<x-api-key>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Returns your organization’s phone numbers. Requires calls:read.

Authorizations

apiKeyAuth

Parameters

Query Parameters

page

integer

default: 1 >= 1

limit

integer

default: 50 >= 1 <= 200

Responses

200

Paginated number roster.

application/json

object

success

boolean

data

Array<object>

A phone number (DID) on your organization.

object

string format: uuid

number

string

friendly_name

string

nullable

status

string

number_type

string

nullable

capabilities

object

key

additional properties

any

created_at

string format: date-time

pagination

Page metadata returned by the paginated Developer API list endpoints. Per-endpoint limit defaults and caps vary (see each endpoint’s limit parameter). In keyset (cursor) mode page, total, and totalPages are null — walk pages via next_cursor instead.

object

page

integer

nullable

limit

Items per page (the default and maximum vary by endpoint).

integer

total

Total matching records across all pages (null in cursor mode).

integer

nullable

totalPages

integer

nullable

Example

{
  "data": [
    {
      "number": "+16473001234",
      "status": "active"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 143,
    "totalPages": 6
  }
}

401

Missing or invalid API key.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}

403

The key is missing the calls:read scope.

application/json

Inline error shape used by the messaging API and management endpoints.

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Recipient phone number (to) is required"
}