List your DID inventory

GET

/api/v2/numbers

curl --request GET \
  --url https://api.sipstack.com/api/v2/numbers \
  --header 'x-api-key: <x-api-key>'

const url = 'https://api.sipstack.com/api/v2/numbers';
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/numbers',
  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 with assignment and provisioning detail, plus DID/voice limit metadata. Upstream carrier/vendor fields are never exposed. Requires numbers:read.

Authorizations

apiKeyAuth

Responses

200

Your DID inventory with limit metadata.

application/json

object

success

boolean

data

Array<object>

A number in your organization’s DID inventory, with assignment and provisioning detail. Upstream carrier/vendor fields are never exposed. Carries additional provisioning fields beyond those listed.

object

string

number

string

friendlyName

string

nullable

status

string

capabilities

object

voice

boolean

sms

boolean

key

additional properties

any

meta

object

didCount

integer

didLimit

-1 = unlimited.

integer

voiceLimit

-1 = unlimited.

integer

canAddDid

boolean

Example

{
  "data": [
    {
      "number": "+16473001234",
      "status": "active"
    }
  ]
}

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 numbers:read scope, or the account API tier is not on your plan.

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"
}