A valid request URL is required to generate request examples{
"items": [
{
"id": "AUIAC-EXQA",
"name": "Main line",
"e164": "+15551234567",
"area_code": "555",
"inbound_cloud_employee_id": "AUIAE-DUXA",
"outbound_cloud_employee_id": "AUIAE-DUXA"
}
],
"total": 100,
"skip": 0,
"limit": 20
}{
"type": "https://example.com/errors/example",
"title": "Bad Request",
"status": 400,
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"errors": [
{
"message": "<string>",
"location": "<string>",
"value": "<unknown>"
}
]
}List phone numbers
List phone numbers with optional filters and pagination.
A valid request URL is required to generate request examples{
"items": [
{
"id": "AUIAC-EXQA",
"name": "Main line",
"e164": "+15551234567",
"area_code": "555",
"inbound_cloud_employee_id": "AUIAE-DUXA",
"outbound_cloud_employee_id": "AUIAE-DUXA"
}
],
"total": 100,
"skip": 0,
"limit": 20
}{
"type": "https://example.com/errors/example",
"title": "Bad Request",
"status": 400,
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"errors": [
{
"message": "<string>",
"location": "<string>",
"value": "<unknown>"
}
]
}Authorizations
API key sent in the X-Api-Key header. Generate an API key from https://app.atonom.ai/#/settings/v2/api_keys.
Query Parameters
Number of matches to skip. Defaults to 0.
x >= 00
Maximum number of matches to return. Defaults to 20, maximum 100.
0 <= x <= 10020
Filter by E.164 substring. Encode leading + as %2B.
"+1555"
Filter by exact NANP area code.
"415"
Response
OK
Items in this page.
Hide child attributes
Hide child attributes
Identifier of the phone number.
10 - 21^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$"AUIAC-EXQA"
Display name of the phone number.
"Main line"
Phone number in E.164 format.
"+15551234567"
NANP area code.
"555"
Identifier of the cloud employee handling inbound calls.
10 - 21^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$"AUIAE-DUXA"
Identifier of the cloud employee handling outbound calls.
10 - 21^[A-Za-z2-7]+-[A-Za-z2-7]{4,}$"AUIAE-DUXA"
Total number of matches before pagination.
100
Number of matches skipped.
0
Maximum number of matches returned.
20