DocumentationAPI Reference
Request Access
Organization structure

Get Locations

GET
/locations

Returns a paginated list of work locations, sorted by location code in ascending order.

Optional Filters:

  • organization-ids — limit to locations whose company belongs to these organizations (max 100)
  • company-ids — limit to locations belonging to these companies (max 100)

Multiple filters combine with AND logic; values within one parameter combine with OR.

Access control: Results are limited to locations belonging to companies your integration has access to. When organization-ids is supplied, only locations from organizations containing at least one accessible company are included. Inaccessible IDs in filter parameters are silently excluded; if none match, an empty list is returned.

Error Details:

  • 400 Bad Request — more than 100 IDs supplied to organization-ids or company-ids, or page-size outside 1–500

Authorization

XApiKey
X-API-KEY<token>

Your API key.

In: header

Query Parameters

api-version*string

API version

Default"3.0"
Value in"3.0"
page-number?integer

Page number (1-based). Defaults to 1 if not specified.

Formatint32
Range1 <= value <= 2147483647
page-size?integer

Number of items per page. Defaults to 100 if not specified. Maximum 500.

Formatint32
Range1 <= value <= 500
organization-ids?array<>

Optional. Return only locations whose company belongs to these organizations. Maximum 100 IDs per request.

Itemsitems <= 100
company-ids?array<>

Optional. Return only locations that belong to these companies. Maximum 100 IDs per request.

Itemsitems <= 100

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/locations?api-version=3.0"
{
  "pageNumber": 0,
  "pageSize": 0,
  "totalItemsCount": 0,
  "items": [
    {
      "id": 0,
      "code": "string",
      "description": "string",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "companyId": 0,
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "isWorkFromHome": true
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Get Location GET

Returns a single location by ID. **Access control:** Returns 404 if the location does not exist or it belongs to a company your integration does not have access to. **Error Details:** - **404 Not Found** — location does not exist or belongs to a company your integration does not have access to

Get Organization GET

Returns a single organization by ID. The response includes only the companies within it that your integration has access to. **Access control:** Returns 404 if the organization does not exist or your integration does not have access to any company within it. The response includes only the companies your integration can access. **Error Details:** - **404 Not Found** — organization does not exist or your integration has no accessible company within it