"tshirt_size": "medium". An unset attribute returns null; archived attributes
are omitted. Update a worker writes these fields.
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
string
Unique identifier for the object, e.g.
wr_yLSx6.string | null
The worker type. One of
employee, contractor, or vendor, or null
before an employment is assigned.string | null
Company-assigned worker number, if one has been set.
string | null
Identifier of the entity assigned to the worker.
string
Identifier of the worker’s workspace.
string | null
Current job title from the worker’s primary employment.
string | object
The worker’s display name by default. Expand
name on
Get a worker to receive the full name object.string | object
The worker’s primary email address by default. Expand
email on
Get a worker to receive the full email object.string | null
Date of birth in
YYYY-MM-DD format, if available.object
Current compensation snapshot from the worker’s primary employment.
object
Current classification snapshot from the worker’s primary employment. Some
string fields may be empty when no value has been recorded yet.
object
Current role snapshot from the worker’s primary employment.
object
Current reporting snapshot from the worker’s primary employment.
object | null
The worker’s current primary employment snapshot.
string[]
Array of current bank account IDs associated with the worker.