API Reference

Retrieve All AvailablePhoneNumbers

get
https://api.vcita.biz/v3/communication/available_phone_numbers

Overview

Retrieves a list of phone numbers.

Available for Staff, Directory, and Client tokens

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Filter by ISO 3166-1 alpha-2 country code (e.g., "US", "CA", "GB", "AU")

string

Filter by area code (e.g., "302"). Required if country_code is "US".

features
array of strings

Filter by telephony features (e.g., ["VOICE", "SMS"]).

features
number
1 to 10000
Defaults to 1

Page number of results.

number
1 to 100
Defaults to 25

How many items to return per page. Max: 100

Responses

400

Bad request - Invalid query parameters

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient permissions

Updated about 2 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago