Jump to Content

Object Overview

The Workplace Object

A workplace represents a payroll work location used for tax jurisdiction purposes. Employees on payroll or premium plans are assigned to a workplace that determines which state and local tax rules apply.

Returned by

Endpoint	Shape
`GET /workplaces`	List of workplaces
`GET /workplaces/:workplace_id`	Single workplace

Field Reference

Field	Type	Description
`workplace_id`	string	Unique workplace identifier.
`line1`	string	Address line 1.
`line2`	string \| null	Address line 2 (suite, unit, etc.).
`city`	string	City.
`state`	string	Two-letter state code.
`postal_code`	string	Postal / ZIP code.
`country`	string	Two-letter country code.
`active`	boolean	Whether the workplace is currently active.

Example

{
  "workplace_id": "wrk_1a2b3c4d5e6f",
  "line1": "123 Main Street",
  "line2": "Suite 200",
  "city": "San Francisco",
  "state": "CA",
  "postal_code": "94105",
  "country": "US",
  "active": true
}

Related