Skip to main content
GET
/
v1
/
workers
List workers
curl --request GET \
  --url https://api.plane.com/v1/workers \
  --header 'Authorization: Bearer <token>'
{
  "workers": [
    {
      "id": "wr_yLSx6",
      "type": "employee",
      "number": null,
      "title": "Corporate Controller",
      "name": "Grace Thompson",
      "email": "grace.thompson@mail.example.com",
      "dob": null,
      "compensation": {
        "amount": "37.0",
        "unit": "hour",
        "currency": "USD",
        "frequency": "monthly",
        "stock": null,
        "other": null
      },
      "classification": {
        "type": "",
        "status": "",
        "term": "",
        "overtime": null,
        "starts": "2026-03-27",
        "ends": null
      },
      "role": {
        "title": "Corporate Controller",
        "responsibilities": "Financial reporting, internal controls, audit management, compliance",
        "level": "Manager"
      },
      "reporting": {
        "department": null,
        "manager": {
          "name": "",
          "email": "priya@airfoil.example.com"
        },
        "starts": null,
        "ends": null
      },
      "employment": {
        "id": "wre_yLSx6",
        "current": true,
        "status": "active",
        "starts": "2025-03-27",
        "ends": null,
        "primary": true,
        "compensation": {
          "amount": "37.0",
          "unit": "hour",
          "currency": "USD",
          "frequency": "monthly",
          "stock": null,
          "other": null
        },
        "location": {
          "address": {
            "country": "US",
            "city": "San Francisco",
            "line1": "123 Market Street",
            "line2": "Suite 500",
            "postal_code": "94103",
            "state": "CA"
          }
        },
        "classification": {
          "type": "",
          "status": "",
          "term": "",
          "overtime": null,
          "starts": "2026-03-27",
          "ends": null
        },
        "role": {
          "title": "Corporate Controller",
          "responsibilities": "Financial reporting, internal controls, audit management, compliance",
          "level": "Manager"
        },
        "reporting": {
          "department": null,
          "manager": {
            "name": "",
            "email": "priya@airfoil.example.com"
          },
          "starts": null,
          "ends": null
        }
      },
      "accounts": []
    }
  ],
  "cursor": "WyIyMDI2LTAzLTI3VDIxOjE2OjQwLjM3MTA0Mi0wNzowMCIsIndyX3lMU3g2Il0"
}

​
Parameters

​
limit
number
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
​
cursor
string
A value from a previous response that lets you fetch the next page.
​
query
string
Search workers by display name.
​
type
string
Only return workers with this type, one of employee, contractor, or vendor.
​
country
string
Only return workers whose current employment location has this country code.
​
starting_after
string
Return results after this worker ID.
​
ending_before
string
Return results before this worker ID.
​
updated_after
string
Only return workers updated after this timestamp. Use an ISO 8601 datetime such as 2026-03-27T00:00:00Z.

​
Returns

Only one of cursor, starting_after, or ending_before may be provided. Returns a dictionary with a workers property that contains an array of Worker objects. When another page is available, the response also includes a cursor value. 
{
  "workers": [
    {
      "id": "wr_yLSx6",
      "type": "employee",
      "number": null,
      "title": "Corporate Controller",
      "name": "Grace Thompson",
      "email": "grace.thompson@mail.example.com",
      "dob": null,
      "compensation": {
        "amount": "37.0",
        "unit": "hour",
        "currency": "USD",
        "frequency": "monthly",
        "stock": null,
        "other": null
      },
      "classification": {
        "type": "",
        "status": "",
        "term": "",
        "overtime": null,
        "starts": "2026-03-27",
        "ends": null
      },
      "role": {
        "title": "Corporate Controller",
        "responsibilities": "Financial reporting, internal controls, audit management, compliance",
        "level": "Manager"
      },
      "reporting": {
        "department": null,
        "manager": {
          "name": "",
          "email": "priya@airfoil.example.com"
        },
        "starts": null,
        "ends": null
      },
      "employment": {
        "id": "wre_yLSx6",
        "current": true,
        "status": "active",
        "starts": "2025-03-27",
        "ends": null,
        "primary": true,
        "compensation": {
          "amount": "37.0",
          "unit": "hour",
          "currency": "USD",
          "frequency": "monthly",
          "stock": null,
          "other": null
        },
        "location": {
          "address": {
            "country": "US",
            "city": "San Francisco",
            "line1": "123 Market Street",
            "line2": "Suite 500",
            "postal_code": "94103",
            "state": "CA"
          }
        },
        "classification": {
          "type": "",
          "status": "",
          "term": "",
          "overtime": null,
          "starts": "2026-03-27",
          "ends": null
        },
        "role": {
          "title": "Corporate Controller",
          "responsibilities": "Financial reporting, internal controls, audit management, compliance",
          "level": "Manager"
        },
        "reporting": {
          "department": null,
          "manager": {
            "name": "",
            "email": "priya@airfoil.example.com"
          },
          "starts": null,
          "ends": null
        }
      },
      "accounts": []
    }
  ],
  "cursor": "WyIyMDI2LTAzLTI3VDIxOjE2OjQwLjM3MTA0Mi0wNzowMCIsIndyX3lMU3g2Il0"
}