GET/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json

List available toll-free incoming phone numbers

Lists toll-free incoming phone numbers available to an account. Use the filters to narrow results by name, phone number, or origin, and the paging parameters to select a page of results.

8 parameters
AccountSidstringrequired
The account SID, formatted as `AC` followed by 32 hexadecimal characters.
Betabooleanoptional
Whether to include phone numbers new to the platform. Defaults to true when omitted.
FriendlyNamestringoptional
Filter by the friendly name that identifies the phone number resources.
PhoneNumberstringoptional
Filter by a phone number; partial numbers and `*` as a wildcard for any digit are supported.
Originstringoptional
Filter by phone number origin: `twilio` or `hosted`. Defaults to including both origins when omitted.
PageSizeintegeroptional
Number of resources to return per page, from 1 to 1000. Defaults to 50 when omitted.
Pageintegeroptional
Page index for client state. Must be zero or greater.
PageTokenstringoptional
Page token provided by the API for retrieving a page.

1 status code
200Returns a page of incoming phone number objects with pagination metadata and links to adjacent pages.
endintegeroptional
first_page_uristringoptional
next_page_uristringoptional
pageintegeroptional
page_sizeintegeroptional
previous_page_uristringoptional
startintegeroptional
uristringoptional
incoming_phone_numbersarray<object>optional

Error handling

The AccountSid path parameter must be a 34-character SID beginning with AC and followed by 32 hexadecimal characters. Origin, when supplied, must be twilio or hosted; PageSize must be between 1 and 1000, and Page must be zero or greater.