The address object is providing access to essential address information for workspaces.

Availability

The address object is available as a property of the workspace object. It can be accessed through workspace.address. Note that the address property may be null if not set for the workspace.

Properties

The address object contains the following properties:

country
string|null
required

The country code of the address (e.g., “US” for United States).

state
string|null
required

The state or province code (e.g., “DE” for Delaware).

city
string|null
required

The name of the city (e.g., “San Francisco”).

line1
string|null
required

The first line of the street address.

line2
string|null

The second line of the street address (optional).

zip
string|null
required

The postal or ZIP code.

phone_number
string|null
required

The phone number associated with the address.