Skip to main content
A worker address records one use of a place for a worker. The supported purposes are residential, business, and shipping. Addresses can be effective-dated for each purpose.

Attributes

string
Unique identifier for the worker address, e.g. wra_8oWZpQ2rL4sk.
string
The object type. Always worker_address.
string
ID of the worker this address belongs to.
string
Address purpose. One of residential, business, or shipping.
string
Effective start date. null means the address was effective before Plane tracked the worker’s address history.
string
Effective end date. Plane writes this as soon as a successor row is recorded, including when that successor starts in the future. null means the row has no scheduled successor.
boolean
Whether this row is the current address for its worker and purpose.
string
ID of the internal place this use points at. Two addresses with the same place share corrections to that physical address.
string
Address line 1.
string
Address line 2, or null.
string
City.
string
State, province, or subdivision, when applicable.
string
Postal code.
string
Two-letter country code.
string
Timestamp of when the worker address was created.
string
Timestamp of when the worker address was last updated.