CHcheckhq

List workplaces

Changed on

Returns a list of workplaces.

get/workplaces (COPY)

Request

Query parameters

companystring

Return workplaces for this company ID.

limitinteger

Number of workplaces returned per page

Response

200

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
  }
]

Changes