NGngpvan

/worksites

Changed on

Use this endpoint to retrieve all Worksites that are available in the current context.

get/worksites

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/worksites
  • Auth
    HTTP basic

Query parameters

employerIdinteger

Optional; filters results by the Employer with the specified ID

isMyOrganizationboolean

Optional; filters results by whether the Employer associated with the Worksite is designated isMyOrganization

$expandstring

Optional; comma-delimited list of expansion properties: workAreas

$topinteger

Response

200

nextPageLinkunknown
countinteger

Example response

{
  "items": [
    {
      "worksiteId": 124,
      "name": "Forestdale School",
      "isPreferred": true,
      "address": {
        "addressLine1": "74 Sylvan St",
        "city": "Malden",
        "stateOrProvince": "MA",
        "zipOrPostalCode": "02148"
      },
      "employer": {
        "employerId": 99,
        "name": "Malden Public Schools"
      }
    }
  ],
  "count": 1
}

Changes