GET /v1/workers/:id — warp-api

Workers

get/v1/workers/{id}

Path parameters

idstring required

The id of the worker.

Example:wrk_1234

The id of the worker.

Success

idstring required

The id of the worker.

positionstring required

type'employee' | 'contractor' required

status'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.

{
  "id": "wrk_1234",
  "startDate": "2000-01-01",
  "endDate": "2000-01-01",
  "email": "adam@joinwarp.com",
  "workEmail": "adam@joinwarp.com"
}