Skip to main content
POST
/
v1
/
workers
Create a worker
curl --request POST \
  --url https://api.plane.com/v1/workers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "number": "<string>",
  "name": {},
  "email": "<string>",
  "title": "<string>",
  "country": "<string>"
}
'
{
  "id": "wr_my3bjuhvAwSBF5"
}

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.

​
Parameters

​
type
string
required
The worker’s primary employment type, one of employee, contractor or vendor.
​
number
string
The company-assigned employee number. Optional.
​
name
object
required
An object with names associated with this worker.
​
email
string
required
The primary email address of this worker.
​
title
string
The worker’s job title.
​
country
string
Two-letter ISO country code (ISO 3166-1 alpha-2). Optional for contractors and vendors; required before inviting employees.

​
Returns

Returns the created worker ID. Retrieve the full Worker object with Get a worker. Returns an error code if create parameters are invalid. 
{
  "id": "wr_my3bjuhvAwSBF5"
}