Skip to main content

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

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.

  • ]

401: Unauthorized

404: Not found

500: Unexpected Error

502: Bad Gateway

Loading...