---
updatedAt: 2026-06-18T18:55:55.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# The workplace object

Represents the location where an employee works.

Use this object to specify where wages were earned in a Payroll Item. A company can have any number of workplaces.

**Note:** Adding or removing an employee's workplace can change the required withholding information for that employee. Consult the [Employee Onboarding API](https://docs.checkhq.com/docs/employee-onboarding-api) for more information.

```json Sample workplace object
{
  "id": "wrk_oRgjEaRycoCPuS5TqVkm",
  "name": "New York Office",
  "address": {
    "line1": "200 Park Ave",
    "line2": null,
    "city": "New York",
    "state": "NY",
    "postal_code": "10166",
    "country": "US"
  },
  "company": "com_P7JPeBhb8hH23iiReDQ5",
  "active": true,
  "metadata": {}
}
```

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Attribute
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        `id`  
        _string_
      </td>

      <td>
        Unique identifier for the workplace.
      </td>
    </tr>

    <tr>
      <td>
        `name`  
        _string_
      </td>

      <td>
        Human-readable name identifying the workplace.
      </td>
    </tr>

    <tr>
      <td>
        `address`  
        _object_
      </td>

      <td>
        Address of the workplace.
      </td>
    </tr>

    <tr>
      <td>
        `company`  
        _string_
      </td>

      <td>
        ID of the company that this workplace relates to.
      </td>
    </tr>

    <tr>
      <td>
        `active`  
        _boolean_
      </td>

      <td>
        Indicates whether the workplace can be associated with an employee for payroll.
      </td>
    </tr>

    <tr>
      <td>
        `metadata`  
        _object_
      </td>

      <td>
        Additional loosely structured information to associate with the workplace.
      </td>
    </tr>
  </tbody>
</Table>