Carrot reference
...
Fields
Data Types

Address

A Carrot datatype used by fields that store location data.

The Address datatype is not currently supported in Custom Fields. Supported uses for the Address datatype are currently limited to the inbuilt address, workAddress, and remoteWorkAddress fields. address and homeAddress are interchangeable.

Properties

The Address datatype supports the following properties:

Property

Definition

workAddress.street1

Returns value for line one of workAddress, ex. 233 S Wacker Dr.

workAddress.street2

Returns value for line two of workAddress, ex. Unit 2805.

workAddress.street3

Returns value for line three of workAddress.

workAddress.city

Returns value for city of workAddress, ex. Chicago.

workAddress.state

Returns value for state of workAddress, ex. Illinois.

workAddress.country

Returns value for country code of workAddress, ex. US.

workAddress.countryName

Returns value for country name of workAddress, ex. United States.

workAddress.postal

Returns value for postal code of workAddress, ex. 60606.

workAddress.lat

Returns value for latitude of workAddress, ex. 41.87901217911454.

workAddress.lng

Returns value for longitude of workAddress, ex. -87.63587198599579.

Sample usage

address.state if address.country:"US" returns the state if the address is in the United States.

Updated 04 Oct 2023
Doc contributor
Doc contributor
Did this page help you?