A worker represents an employee, contractor, or vendor in your Plane workspace.
The public API returns the worker plus snapshots from the worker’s current
primary employment. That means compensation, classification, role, and
reporting appear directly on the worker and again under employment.
By default, name and email are returned as strings. On
Get a worker , you can request expand[]=name and/or
expand[]=email to receive their full objects instead.
Attributes Unique identifier for the object, e.g. wr_yLSx6.
The worker type. One of employee, contractor, or vendor.
Company-assigned worker number, if one has been set.
Current job title from the worker’s primary employment.
The worker’s display name by default. Expand name on
Get a worker to receive the full name object. Show expanded child attributes
Business name for vendor workers.
The worker’s primary email address by default. Expand email on
Get a worker to receive the full email object. Show expanded child attributes
Date of birth in YYYY-MM-DD format, if available.
Current compensation snapshot from the worker’s primary employment. Time unit for the amount, such as hour, day, month, or year.
Three-letter ISO currency code.
Payment frequency, such as weekly, biweekly, or monthly.
Stock compensation details, if present.
Additional compensation details, if present.
Current classification snapshot from the worker’s primary employment. Some
string fields may be empty when no value has been recorded yet. Classification type, such as salaried or hourly.
Classification status, such as full-time or part-time.
Employment term, such as at-will or fixed.
Whether the worker is overtime eligible.
Effective start date in YYYY-MM-DD format.
Effective end date in YYYY-MM-DD format.
Current role snapshot from the worker’s primary employment. Role responsibilities, if present.
Current reporting snapshot from the worker’s primary employment. Current department, if present. Current manager, if present. Effective start date in YYYY-MM-DD format.
Effective end date in YYYY-MM-DD format.
The worker’s current primary employment snapshot. Whether this employment is current.
Current employment status.
Employment start date in YYYY-MM-DD format.
Employment end date in YYYY-MM-DD format.
Whether this is the worker’s primary employment.
Current compensation snapshot for this employment. Uses the same shape as
the top-level compensation field.
Current work location snapshot for this employment. Address data for the employment’s work location. State, province, or region.
Two-letter ISO country code.
Current classification snapshot for this employment. Uses the same shape
as the top-level classification field.
Current role snapshot for this employment. Uses the same shape as the
top-level role field.
Current reporting snapshot for this employment. Uses the same shape as
the top-level reporting field.
Array of current bank account IDs associated with the worker.
