Addresses API
Addresses are aggregated within people, organizations and sites.
Collection Fields
By default the following fields will appear in collections of contacts:
label uri
Obtain a different set of fields using the ?fields= parameter.
Sorting
Collections of contacts are sorted ascending by label.
Fields
- address
- Optional string (max 1024) — The address lines.
- addressable
- Required reference to Person, Organization or Site — The entity to address.
- city
- Optional string (max 128) — The city name.
- country
- Optional string (max 128) — The country name.
- id
- Readonly integer — The unique ID of the address.
- integration
- Optional boolean, default:
false— The Integration field is a hidden checkbox that can be set totrueusing this API or the Import functionality. When checked, the address is displayed as read-only in the user interface to prevent users from updating it. - label
- Required enum — The Label of the address details. Valid values are:
-
home: only for peoplestreet: only for organizations and sitesmailing: only for organizations and peoplebilling: only for organizations
- state
- Optional string (max 30) — The state name.
- zip
- Optional string (max 20) — The zip code.