Organization structure

Get Location

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

Authorization

XApiKey

X-API-KEY<token>

Your API key.

In: header

Path Parameters

id*integer

The unique identifier of the location to retrieve.

Formatint32

Query Parameters

api-version*string

API version

Default"3.0"

Value in"3.0"

Response Body

curl -X GET "https://external-app-prod.netchexonline.net/locations/0?api-version=3.0"

{
  "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 Departments GET

Returns a paginated list of departments. Each department includes its full parent hierarchy: organization → company → division → business unit → department. **Optional Filters:** - `organization-ids` — limit to departments whose company belongs to these organizations (max 100) - `company-ids` — limit to departments belonging to these companies (max 100) - `division-ids` — limit to departments belonging to these divisions (max 100) - `business-unit-ids` — limit to departments belonging to these business units (max 100) Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to departments belonging to companies your integration has access to. When `organization-ids` is supplied, only departments 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 any filter parameter, or `page-size` outside 1–500

Get Locations GET

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