Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.plane.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
id
string
Unique identifier for the object, e.g. wr_yLSx6.
​
type
string
The worker type. One of employee, contractor, or vendor.
​
number
string | null
Company-assigned worker number, if one has been set.
​
title
string | null
Current job title from the worker’s primary employment.
​
name
string | object
The worker’s display name by default. Expand name on Get a worker to receive the full name object.
​
email
string | object
The worker’s primary email address by default. Expand email on Get a worker to receive the full email object.
​
dob
string | null
Date of birth in YYYY-MM-DD format, if available.
​
compensation
object
Current compensation snapshot from the worker’s primary employment.
​
classification
object
Current classification snapshot from the worker’s primary employment. Some string fields may be empty when no value has been recorded yet.
​
role
object
Current role snapshot from the worker’s primary employment.
​
reporting
object
Current reporting snapshot from the worker’s primary employment.
​
employment
object | null
The worker’s current primary employment snapshot.
​
accounts
string[]
Array of current bank account IDs associated with the worker.