Get Organization
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
Authorization
XApiKey Your API key.
In: header
Path Parameters
The unique identifier (GUID) of the organization to retrieve.
uuidQuery Parameters
API version
"3.0""3.0"Response Body
curl -X GET "https://external-app-prod.netchexonline.net/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08?api-version=3.0"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"companies": [
{
"id": 0,
"code": "string",
"name": "string"
}
]
}{
"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 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
Get Organizations GET
Returns a paginated list of organizations. Each organization has one or more companies. **Optional Filters:** - `organization-ids` — limit to these organizations (max 100) - `company-ids` — limit to organizations containing these companies (max 100) Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Only organizations containing at least one company your integration can access are returned. Inaccessible IDs in `company-ids` are silently excluded; if none match, an empty list is returned. Each organization in the response includes only the companies your integration can access. **Error Details:** - **400 Bad Request** — more than 100 IDs supplied to `organization-ids` or `company-ids`, or `page-size` outside 1–500