Skip to main content
GET
List phone numbers
Returns a list of phone numbers purchased and assigned to your account.

Overview

Use this endpoint to see the numbers your account owns. For each number it returns:
  • the number in E.164 format (e164), its country and region
  • its capabilities (voice, SMS, MMS, fax) and status
  • its rental cost (setup_fee, monthly_fee, currency) and billing dates
  • the application it is routed to (application_id)
Results are paginated with page and per_page, and you can narrow them to one number with search.
Authentication required:
  • X-Auth-ID - Your Auth ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

Query Parameters

The request and response both use page and per_page. The limit and offset parameters do not control pagination for this endpoint.
Use search to filter by phone number.
Master Accounts (MA_): results from a master account include numbers owned by its sub-accounts (SA_). Each item’s account_id tells you which account owns it.

Request

cURL

Search owned numbers

Use --data-urlencode to preserve the leading + in an E.164 number. Writing a raw + in a query string can decode as a space.
cURL

Response Example

Success Response (200 OK)

Response structure

Phone number fields

Each object in items has these fields. Descriptions come from The Account Phone Number Object.

Number status values

Only phone numbers owned by an account (with a populated account_id) are returned. Numbers still in inventory (auth_id=NULL) are not included - browse those with List Inventory Numbers.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

Query Parameters

page
integer
default:1

Page number, starting at 1

Required range: x >= 1
per_page
integer
default:25

Number of phone numbers to return per page

Required range: x >= 1

Filter by phone number. Include the country code and URL-encode a leading plus sign.

Example:

"+919876543210"

Response

200 - application/json

List of phone numbers

items
object[]
required
page
integer
required
per_page
integer
required
total
integer
required