CHcheckhq

List workplaces

Changed on

Returns a list of workplaces.

get/workplaces

Request

Query parameters

companystring

Return workplaces for this company ID.

limitinteger

Number of workplaces returned per page. The maximum value is 500.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

metadataobject

Return only results whose metadata contains every given key and value, for example metadata[external_id]=123. Pass keys using bracket notation. Multiple keys are combined with AND. Brackets must be URL-encoded in request URLs (metadata%5Bkey%5D=value).

Response

200

nextstring
previousstring

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

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter metadata