Phone Numbers

List Phone Numbers

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Query parameters

searchstringOptional<=100 characters

This will search phone numbers by name, number, or SIP URI (partial match, case-insensitive).

pagedoubleOptional>=1
This is the page number to return. Defaults to 1.
sortOrderenumOptional
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
limitdoubleOptional>=0<=1000
This is the maximum number of items to return. Defaults to 100.
createdAtGtstringOptionalformat: "date-time"
This will return items where the createdAt is greater than the specified value.
createdAtLtstringOptionalformat: "date-time"
This will return items where the createdAt is less than the specified value.
createdAtGestringOptionalformat: "date-time"
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLestringOptionalformat: "date-time"
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGtstringOptionalformat: "date-time"
This will return items where the updatedAt is greater than the specified value.
updatedAtLtstringOptionalformat: "date-time"
This will return items where the updatedAt is less than the specified value.
updatedAtGestringOptionalformat: "date-time"
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLestringOptionalformat: "date-time"
This will return items where the updatedAt is less than or equal to the specified value.

Response

resultslist of objects
A list of phone numbers, which can be of any provider type.
metadataobject
Metadata about the pagination.