Retrieve Phone Numbers

Returns a list of Phone Numbers applicable to the scope of the API auth token

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

Filter via case ID. Must supply integer value, cannot search by case name or other field information.

string

Filter via number. Wildcards supported. eg. number=123% will return all phone numbers with numbers beginning with 123 ( eg. for searching area code ). Do not use quotations like number="123%".

string

Filter via extension. Wildcards supported. eg. extension=2% will return all phone numbers with extensions beginning with 2. Do not use quotations like extension="2%".

string

Filter via phone_type. Wildcards supported. eg. phone_type=cell% will return all phone numbers with a phone_type starting with "cell" like "Cell Phone" and "Cellular Device". Do not use quotations like phone_type="cell%".

string

Filter via phone_carrier. Wildcards supported. eg. phone_carrier=Ver% will return all phone numbers with carriers like "Verizon" and "Veriphone". Do not use quotations like phone_carrier="Ver%".

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

string

Filter via raw phone number (unformatted). Wildcards supported. e.g. raw_number=B% will return all records beginning with 'B'. Do not use quotations like raw_number="B%".

string

Filter via phone number description. Wildcards supported. e.g. description=B% will return all records beginning with 'B'. Do not use quotations like description="B%".

Response

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