v1

latestOpenAPI 3.1.02026-07-241642423.7 KB

Create a workplace

Creates a new workplace.

post/workplaces

Request body

companystring required

The company ID to associate with the workplace

namestring

The name for the workplace

activeboolean

Indicates whether the workplace can be associated with an employee for payroll

metadatastring json

Additional loosely structured information to associate with the workplace

Response

201

idstring

namestring

companystring

activeboolean

metadataobject

Example response

{
  "id": "wrk_oRgjEaRycoCPuS5TqVkm",
  "name": "New York Office",
  "address": {
    "line1": "200 Park Ave",
    "city": "New York",
    "state": "NY",
    "postal_code": "10166",
    "country": "US"
  },
  "company": "com_P7JPeBhb8hH23iiReDQ5",
  "active": true
}