v1
latestOpenAPI 3.1.02026-07-241642423.7 KBList workplaces
Returns a list of workplaces.
get/workplaces
Query parameters
companystring
Return workplaces for this company ID.
limitinteger
Number of workplaces returned per page. The maximum value is 500.
Response
200
Example response
{
"next": "https://sandbox.checkhq.com/workplaces?cursor=cD0lNUIlMjIyMDI1LTA5LTI0KzEyJTNBNTclM0E1Ny43NDE2MzglMkIwMCUzQTAwJTIyJTJDKyUyMjQyMzQxNjclMjIlNUQ%3D",
"results": [
{
"id": "wrk_Cjy24FaEY59iyC7MM6Yg",
"name": "Office",
"address": {
"line1": "36 E 30th St",
"city": "New York",
"state": "NY",
"postal_code": "10016",
"country": "US"
},
"company": "com_GlAxMQVO1ZJ0BNbO6pss",
"active": true
}
]
}