Skip to navigation
Common ModelsAddresses

/addresses/{id}

Returns an Address object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

Allowed values:
show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

Allowed values:

Response

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
typeenum or nullOptional

The address type. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=type to receive the integration’s own value instead.

Allowed values:
street_1string or nullOptional
Line 1 of the address's street.
street_2string or nullOptional
Line 2 of the address's street.
citystring or nullOptional
The address's city.
stateany or nullOptionalRead-only
The address's state or region.
country_subdivisionstring or nullOptional
The address's state or region.
countryenum or nullOptional

The address’s country. The country code in ISO 3166-1 alpha-2 format.

zip_codestring or nullOptional
The address's zip code.

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information