Skip to navigation
Compatibility REST APIIncoming Phone Numbers

List all Incoming Phone Numbers

View as MarkdownOpen in Claude

Lists the Incoming Phone Number resources owned by the account. These numbers can route calls, messages, and faxes through the project. Use Available Phone Numbers to search inventory, or SignalWire REST List phone numbers for JSON requests.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the account that is associated with this phone number.

Query parameters

PageintegerOptional>=0Defaults to 0

The page index to retrieve. Zero-indexed.

PageSizeintegerOptional1-1000Defaults to 50
The number of results per page. Default is 50, maximum is 1000.
PageTokenstringOptional

Token for cursor-based pagination. Required when Page > 0.

PhoneNumberstringOptional
Only show numbers that match this pattern.
FriendlyNamestringOptional
Only show numbers with this friendly name.

Response

The request has succeeded.
uristring
The URI of the current page.
first_page_uristring
The URI of the first page.
next_page_uristring or null
The URI of the next page, or null if there are no more pages.
previous_page_uristring or null
The URI of the previous page, or null if this is the first page.
pageinteger
The current page number.
page_sizeinteger
The number of items per page.
incoming_phone_numberslist of objects
List of incoming phone numbers.

Errors

400
Bad Request Error
401
Unauthorized Error
422
Unprocessable Entity Error