v53

OpenAPI 3.1.0raw.githubusercontent.com2026-08-041,1941,9384.1 MB

External Connections

List all civic addresses and locations

Returns the civic addresses and locations from Microsoft Teams.

get/external_connections/{id}/civic_addresses

Path parameters

idstring required

Example:1293384261075731499

Identifies the resource.

Query parameters

countrystring[]

The country (or countries) to filter addresses by.

Filter parameter for civic addresses (deepObject style). Supports filtering by country.

{
  "country": [
    "US",
    "CA",
    "MX",
    "BR"
  ]
}

Response

Successful response

Example response

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