GET
/
workers
curl --request GET \
  --url https://api.plane.com/v1/workers \
  --header 'Authorization: Bearer <token>'
{
  "workers": [
    {
      "id": "wr_5yMmVvd6Cz7Ptx",
      "type": "employee",
      "number": null,
      "title": "CAO",
      "name": "Frigga Odinson",
      "email": "frigga@example.com",
      "dob": null
    },
    {...},
    {...}
  ]
}

​
Parameters

​
limit
string

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

​
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

​
ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

​
Returns

A dictionaty with a workers property that contains an array fo up to limit workers, starting after worker starting_after. Each entry in the array is a separate worker object. If no more workers are available, the resulting array will be empty.

{
  "workers": [
    {
      "id": "wr_5yMmVvd6Cz7Ptx",
      "type": "employee",
      "number": null,
      "title": "CAO",
      "name": "Frigga Odinson",
      "email": "frigga@example.com",
      "dob": null
    },
    {...},
    {...}
  ]
}

Was this page helpful?

Create a workerGet a worker