Retrieve a Civic Address

GET 
/external_connections/:id/civic_addresses/:address_id

Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.

Request

Path Parameters

id int64required

Identifies the resource.

address_id uuidrequired

Identifies a civic address or a location.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Uniquely identifies the resource.

record_type string

Identifies the type of the resource.

city_or_town string

city_or_town_alias string

company_name string

country string

country_or_district string

default_location_id uuid

Identifies what is the default location in the list of locations.

description string

house_number string

house_number_suffix string

postal_or_zip_code string

state_or_province string

street_name string

street_suffix string

locations

object[]

Array [

id uuid

Uniquely identifies the resource.

additional_info string

description string

is_default boolean

Represents whether the location is the default or not.

]

{
  "data": {
    "id": "07a4dc5d-9b3b-4ba2-88a4-6ba172316c65",
    "record_type": "civic_address",
    "city_or_town": "Chicago",
    "city_or_town_alias": null,
    "company_name": "Telnyx",
    "country": "US",
    "county_or_district": "US",
    "default_location_id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
    "description": "Chicago Office",
    "house_number": "311",
    "house_number_suffix": null,
    "locations": [
      {
        "id": "18ded4bb-b694-44c1-a89b-a35b7acd4c9e",
        "additional_info": null,
        "description": "Chicago Office",
        "is_default": true
      },
      {
        "id": "d420a57f-c4ae-4697-87e1-fbefd9e86f72",
        "additional_info": "Main building, Suite 504",
        "description": null,
        "is_default": false
      }
    ],
    "postal_or_zip_code": "60654",
    "state_or_province": "IL",
    "street_name": "West Superior Street",
    "street_suffix": null
  }
}

401: Unauthorized

404: Not found

500: Unexpected Error

502: Bad Gateway

Loading...