Skip to main content

Retrieve an Address

GET 
/addresses/:id

Retrieves the details of an Address that has been previously created. Use the unique ID that was returned from your previous request to identify the specific instance.

Permissions​

The API token must include the following scopes: Numbers.

Request​

Path Parameters

    id uuidrequired

    Unique ID of the address

Responses​

OK

Schema

    id uuidrequired

    The unique identifier of the Address on SignalWire. This can be used to show or delete the address programmatically.

    label stringrequired

    A friendly name given to the address to help distinguish and search for different addresses within your project.

    Example: My Address
    country stringrequired

    The ISO 3166 Alpha 2 country code.

    Example: US
    first_name stringrequired

    First name of the occupant associated with this address.

    Example: Emmett
    last_name stringrequired

    Last name of the occupant associated with this address.

    Example: Brown
    street_number stringrequired

    The number portion of the street address.

    Example: 1640
    street_name stringrequired

    The name portion of the street address.

    Example: Riverside Drive
    address_type string

    (Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies how the address is divided. If the address is a single occupant address, address_type may be omitted. Possible values are: Apartment, Basement, Building, Department, Floor, Office, Penthouse, Suite, Trailer, Unit.

    Example: Apartment
    address_number string

    (Optional) If the address is divided into multiple sub-addresses, such as an apartment or office building, this identifies the particular sub-address. If the address is a single occupant address, address_number may be omitted.

    Example: 42
    city stringrequired

    The city portion of the street address.

    Example: Alexandria
    state stringrequired

    The state/province/region of the street address. In the USA and Canada, use the two-letter abbreviated form, such as CA for California.

    Example: CA
    postal_code stringrequired

    The postal code of the street address.

    Example: 91905