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 Workforce::Plan is a persistent hiring or headcount scenario. It groups positions over a planning window and can point to the latest immutable workforce calculation snapshot.

​
Attributes

​
id
string
Unique identifier for the plan, e.g. wfp_R8mK2pQ9xL4s.
​
object
string
The object type. Always workforce_plan.
​
name
string
Human-readable plan name.
​
status
string
Plan status. One of draft, approved, or archived.
​
starts
string
Start date for the planning window.
​
ends
string
End date for the planning window.
​
frequency
string
Planning frequency. Currently monthly.
​
currency
string
Three-letter ISO currency code used for plan-level calculation rollups.
​
positions
array
Positions currently attached to the plan.
​
calculation
string
ID of the latest calculation snapshot attached to the plan.
​
metadata
object
Set of key-value pairs attached to the plan.
​
created
string
Timestamp of when the plan was created.
​
updated
string
Timestamp of when the plan was last updated.