Skip to main content
GET
/
external_connections
/
{id}
/
civic_addresses
/
{address_id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const civicAddress = await client.externalConnections.civicAddresses.retrieve(
  '318fb664-d341-44d2-8405-e6bfb9ced6d9',
  { id: 'id' },
);

console.log(civicAddress.data);
{
  "data": {
    "id": "07a4dc5d-9b3b-4ba2-88a4-6ba172316c65",
    "record_type": "civic_address",
    "city_or_town": "Austin",
    "city_or_town_alias": "",
    "company_name": "Telnyx",
    "country": "US",
    "county_or_district": "US",
    "default_location_id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
    "description": "Austin Office",
    "house_number": "600",
    "house_number_suffix": "",
    "locations": [
      {
        "id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
        "additional_info": "",
        "description": "Austin Office",
        "is_default": true
      },
      {
        "id": "d420a57f-c4ae-4697-87e1-fbefd9e86f72",
        "additional_info": "14th Floor",
        "description": "",
        "is_default": false
      }
    ],
    "postal_or_zip_code": "78701",
    "state_or_province": "TX",
    "street_name": "Congress Street",
    "street_suffix": ""
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<int64>
required

Identifies the resource.

Example:

"1293384261075731499"

​
address_id
string<uuid>
required

Identifies a civic address or a location.

Example:

"318fb664-d341-44d2-8405-e6bfb9ced6d9"

Response

Successful response

​
data
object
Example:
{
  "id": "07a4dc5d-9b3b-4ba2-88a4-6ba172316c65",
  "record_type": "civic_address",
  "city_or_town": "Austin",
  "city_or_town_alias": "",
  "company_name": "Telnyx",
  "country": "US",
  "county_or_district": "US",
  "default_location_id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
  "description": "Austin Office",
  "house_number": "600",
  "house_number_suffix": "",
  "locations": [
    {
      "id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
      "additional_info": "",
      "description": "Austin Office",
      "is_default": true
    },
    {
      "id": "d420a57f-c4ae-4697-87e1-fbefd9e86f72",
      "additional_info": "14th Floor",
      "description": "",
      "is_default": false
    }
  ],
  "postal_or_zip_code": "78701",
  "state_or_province": "TX",
  "street_name": "Congress Street",
  "street_suffix": ""
}