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

id
string
Unique identifier for the worker address, e.g. wra_8oWZpQ2rL4sk.
object
string
The object type. Always worker_address.
worker
string
ID of the worker this address belongs to.
purpose
string
Address purpose. One of residential, business, or shipping.
starts
string
Effective start date. null means the address was effective before Plane tracked the worker’s address history.
ends
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.
current
boolean
Whether this row is the current address for its worker and purpose.
place
string
ID of the internal place this use points at. Two addresses with the same place share corrections to that physical address.
line1
string
Address line 1.
line2
string
Address line 2, or null.
city
string
City.
state
string
State, province, or subdivision, when applicable.
postal_code
string
Postal code.
country
string
Two-letter country code.
created
string
Timestamp of when the worker address was created.
updated
string
Timestamp of when the worker address was last updated.