Skip to main content

Get an Account Address

GET 
/v2/accounts/:accountID/addresses/:addressID

Get an Account Addresses

Request​

Path Parameters

    accountID stringrequired

    The ID of the account you want to retrieve.

    addressID stringrequired

    The ID of the address you want to retrieve.

Responses​

OK

Schema
    data object
    type string

    Default value: address

    Specifies the the type of object. Set this value to address.

    first_name string

    The first name of the recipient on this address.

    last_name string

    The last name of the recipient on this address.

    name string

    The name for the address saved, such as home, work or wife’s office.

    phone_number string

    A phone number for this address.

    instructions string

    Any delivery instructions for this address.

    company_name string

    The company name at this address.

    line_1 string

    The first portion of the address, usually the street address.

    line_2 string

    The second portion of the address, usually an apartment or unit number.

    city string

    The city for this address.

    county string

    The county for this address.

    region string

    The state, province, territory, etc. for this address.

    postcode string

    The ZIP Code, Postcode, or other postal reference string for this delivery address.

    country string

    A two digit code for the country this address is in, expressed as per the ISO 3166-2 standard.

    id string

    The unique identifier for an Address.

    meta object
    timestamps object
    created_at string

    The date the address is created.

    updated_at string

    The date the address is updated.

    links object
    self string

    A URL to the specific resource.

    relationships object
    account object
    id string

    The ID of the account.

    type string

    The type of object being returned.

Loading...