Sign in

v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-271727149.6 KB
Workers

Get a specific worker by id.

get/v1/workers/{id}

Path parameters

idstring required

The id of the worker.

Example:wrk_1234

The id of the worker.

Response

Success

idstring required

The id of the worker.

positionstring required
type'employee' | 'contractor' required
status'draft' | 'invited' | 'onboarding' | 'active' | 'offboarding' | 'inactive' required
startDatestring required

A date string in the form YYYY-MM-DD

endDatestring nullable required

A date string in the form YYYY-MM-DD

isBusinessboolean nullable required
businessNamestring nullable required
firstNamestring required
lastNamestring required
emailstring required

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

workEmailstring nullable required

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

preferredNamestring nullable required
displayNamestring required

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.

timeZonestring nullable required

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

Example response

{
  "id": "wrk_1234",
  "position": "Research Engineer",
  "startDate": "2000-01-01",
  "endDate": "2000-01-01",
  "firstName": "Jonathan",
  "lastName": "Galt",
  "email": "john@joinwarp.com",
  "workEmail": "john@joinwarp.com",
  "preferredName": "John",
  "displayName": "Jack Galt",
  "timeZone": "America/New_York",
  "department": {
    "id": "dpt_1234",
    "name": "Engineering"
  }
}