Workers
Create a worker
Workers
Create a worker
Add a team member or vendor to Plane.
POST
/
workers
curl --request POST \
--url https://api.plane.com/v1/workers \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "<string>",
"number": "<string>",
"name": {},
"email": "<string>",
"title": "<string>"
}'{
"id": "wr_my3bjuhvAwSBF5",
}
Parameters
type
string
requiredThe worker’s primary employment type, one of employee, contractor or vendor.
number
string
The company-assigned employee number. Optional.
name
object
requiredAn object with names associated with this worker.
email
string
requiredThe primary email address of this worker.
title
string
The worker’s job title.
Returns
Returns the Worker object after successful worker creation. Returns an error code if create parameters are invalid.
Was this page helpful?
curl --request POST \
--url https://api.plane.com/v1/workers \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"type": "<string>",
"number": "<string>",
"name": {},
"email": "<string>",
"title": "<string>"
}'{
"id": "wr_my3bjuhvAwSBF5",
}