List

get/v1/workers

List all workers. Workers includ

Query ParametersExpand Collapse

afterId: optional string

The id of the worker.

beforeId: optional string

The id of the worker.

limit: optional string

a number less than or equal to 100

statuses: optional array of "onboarding" or "active" or "offboarding" or "inactive"

Accepts one of the following:

"onboarding"

"active"

"offboarding"

"inactive"

types: optional array of "employee" or "contractor"

Accepts one of the following:

"employee"

"contractor"

workEmail: optional string

ReturnsExpand Collapse

count: number

an integer

data: array of object { id, businessName, displayName, 12 more }

id: string

The id of the worker.

businessName: string

displayName: string

The "ui" name of a worker. If it's a business contractor business name is used. Otherwise we default to preferred name, then first-last.

email: string

An email with a reasonably valid regex (shamelessly taken from zod)

endDate: string

A date string in the form YYYY-MM-DD

firstName: string

isBusiness: boolean

lastName: string

position: string

preferredName: string

startDate: string

A date string in the form YYYY-MM-DD

status: "onboarding" or "active" or "offboarding" or "inactive"

Accepts one of the following:

"onboarding"

"active"

"offboarding"

"inactive"

timeZone: string

The IANA timezone of the worker (e.g., America/New_York).

type: "employee" or "contractor"

Accepts one of the following:

"employee"

"contractor"

workEmail: string

An email with a reasonably valid regex (shamelessly taken from zod)

hasMore: boolean

curl https://api.joinwarp.com/v1/workers \
    -H "x-api-key: $WARP_API_KEY"

{
  "count": 0,
  "data": [
    {
      "id": "wrk_1234",
      "businessName": null,
      "displayName": "Jack Galt",
      "email": "john@joinwarp.com",
      "endDate": "2000-01-01",
      "firstName": "Jonathan",
      "isBusiness": false,
      "lastName": "Galt",
      "position": "Research Engineer",
      "preferredName": "John",
      "startDate": "2000-01-01",
      "status": "onboarding",
      "timeZone": "America/New_York",
      "type": "employee",
      "workEmail": "john@joinwarp.com"
    }
  ],
  "hasMore": true
}

Returns Examples

{
  "count": 0,
  "data": [
    {
      "id": "wrk_1234",
      "businessName": null,
      "displayName": "Jack Galt",
      "email": "john@joinwarp.com",
      "endDate": "2000-01-01",
      "firstName": "Jonathan",
      "isBusiness": false,
      "lastName": "Galt",
      "position": "Research Engineer",
      "preferredName": "John",
      "startDate": "2000-01-01",
      "status": "onboarding",
      "timeZone": "America/New_York",
      "type": "employee",
      "workEmail": "john@joinwarp.com"
    }
  ],
  "hasMore": true
}