Skip to navigation
Atlas APIPhone Numbers

Get phone number by ID

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

idstringRequired

Response

Successful response
PartitionKeystringOptional
RowKeystringOptional
TimestampdatetimeOptional
PhoneNumberstringOptional
ProviderenumOptional
Allowed values:
SIPCredentialIdstringOptional
SIPGatewayIpsstringOptional
JSON array of SIP gateway IP addresses
InternalNumberbooleanOptional
TrustProductAttachRejectedbooleanOptional

Whether Twilio rejected attaching this number to the Trust Product (e.g. regulation country mismatch)

TrustProductAttachRejectReasonstringOptional
Twilio's reason for rejecting the Trust Product attachment
TwilioAccountSidstringOptional

Twilio account SID (Twilio provider only)

TelnyxAccountKeystringOptional

Telnyx billing group ID (Telnyx provider only)

campaignIdslist of stringsOptional
callTypeslist of stringsOptional

Errors

404
Not Found Error
500
Internal Server Error