Phone Numbers
Search phone numbers
Search for your phone numbers.
get/numbers
Query parameters
sidstring
Short ID
Example:callrsid
Phone number SID
class'gold' | 'classic'
Number class. "gold" is for premium (rare) numbers, "classic" is for regular numbers.
Example:classic
Number class
type'geographic' | 'mobile' | 'non-geographic' | 'personal' | 'platform' | 'sharedrevenue' | 'sms-only' | 'special' | 'tollfree' | 'verified'
Type of number
Example:geographic
Number type
containsstring
Search by number. You can use a partial number.
detachedtrue
Search for detached numbers only. You can only pass true to this parameter. Detached numbers are phone numbers that are currently not attached to any scenario.
sort'assigned' | 'e164'
Sort by one field
order'asc' | 'desc'
Sort order (ascending or descending)
offsetinteger
Offset index (zero-based)
Search offset index (zero-based)
limitinteger
Limit search results
Example:20
Number of items to return
Response
Search results
Example response
{
"total": 20,
"hits": [
{
"e164": "+33199001234",
"class": "classic",
"type": "geographic",
"assigned": "2024-04-24T17:42:28Z",
"country": "FR",
"scenario": {
"sid": "callrsid",
"name": "My Call Flow",
"type": {
"name": "Actions",
"version": "1.0"
}
},
"compliance": {
"blockedAfter": "2024-04-24T17:42:28Z"
},
"contract": {
"ends": "2024-04-24T17:42:28Z"
},
"pricing": {
"minute": "5.50",
"mrc": "5.50",
"nrc": "5.50",
"setup": "5.50"
},
"enduser": {
"name": "French Corp",
"address": {
"country": "FR",
"city": "Paris"
},
"comment": "French Subsidiary",
"sid": "callrsid",
"type": "third-party",
"created": "2024-04-24T17:42:28Z",
"updated": "2024-04-24T17:42:28Z",
"deletable": true,
"freeze": {
"unfreeze": "2024-04-24T17:42:28Z",
"frozen": true
},
"compliance": {
"status": "no-rules-required",
"compliant": true
}
}
}
]
}