Get Work Locations

Fetch Work Location(s) by company and/or specific parameters.

get/workLocations

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/workLocations/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

companyIDstring required

Company ID of the employer

workLocationIDstring

Work Location ID of the object you're querying

taxableLocationIDstring

Taxable Location ID of the object(s) you are querying

statestring[]

The array of US States (2 letter abbreviation) applicable to the objects that you are querying

work_site_idstring

ID assigned to the Work Location

Response

200

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "workLocationID": "531fece70b6d0b5d29c9f352",
      "companyID": "1234567890",
      "taxableLocationID": "609ffdf81a5f9c4c10b0c443",
      "name": "Head Quarters",
      "work_site_id": "HQ"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.