Addresses
The addresses
table contains data about physical or mailing addresses in the system, such as those attached to entities or tags.
This table can be used to determine what addresses exist and which objects they are attached to, as well as metadata about the address such as when it was created.
Columns
Column Name | Description | Type | Nullable |
---|---|---|---|
id | The numerical identifier of the object. | INT8 | No |
street_address | The street section of the address. | VARCHAR | Yes |
complement | The second line of the address. This column is currently unused by the system and will be blank and any contents ignored. | VARCHAR | Yes |
city | The city section of the address. | VARCHAR | Yes |
state | The state or province section of the address, as a two character abbreviation. | VARCHAR | Yes |
postal_code | The postal code or ZIP code section of the address. | VARCHAR | Yes |
latitude | The latitude of the address. | FLOAT8 | Yes |
longitude | The longitude of the address. | FLOAT8 | Yes |
owner_id | The numerical identifier of the related object for this address. Can be used with owner_type to look up the object itself in the appropriate table. |
INT8 | No |
owner_type | The name of the class of object this address is attached to. One of Tag , Entity , ActionAssignmentGroupUser , or CalendarEvent . |
VARCHAR | No |
created_by_id | The numerical identifier of the user that created this address. Relates to the id column in the users table. An ID of 1 typically means a machine-created address, such as over the API. |
INT8 | No |
status | The status of the address, as displayed on the user interface. One of user_added , verified , bad , or do_not_contact . |
VARCHAR | Yes |
created_at | The UTC timestamp when this object was created. | TIMESTAMP | No |
updated_at | The UTC timestamp when this object was last updated. | TIMESTAMP | No |
geocode_source | The source of the latitude and longitude geocode. user_added means entered by a user either manually or via upload or the API. Other results come from our geocoding service. |
VARCHAR | Yes |
geocode_bad | Notes if the geocoded latitude and longitude was marked as bad or not. | BOOL | Yes |
timezone | The timezone of the address, in TZ Identifier format. | VARCHAR | Yes |
accuracy | The accuracy of the geocoded latitude and longitude, as returned by our geocoding service. | FLOAT8 | Yes |
accuracy_type | The type of accuracy of the geocoded latitude and longitude, as returned by our geocoding service. | VARCHAR | Yes |
updated_by_id | The numerical identifier of the user that last updated this address. Relates to the id column in the users table. An ID of 1 typically means a machine-updated address, such as over the API. |
INT4 | Yes |
country | The two character country code of the address. | VARCHAR(2) | Yes |
dw_id | The DWID of the address, if matched to Catalist using the Catalist sync feature. | VARCHAR | Yes |
interact_id | The UUID of the address, for use on the API. | UUID | No |
source | The source of the address as displayed on the user interface. One of action_builder , upload , action_network , or api . |
VARCHAR | Yes |
original_address | A JSON representation of the originally entered address, if the address has been normalized. | JSONB | Yes |
normalized | Whether the address has been normalized or not. | BOOL | Yes |
address_type | The type of address. One of mailing or physical . |
VARCHAR | No |