Get Company
Returns a single company by ID.
Access control: Returns 404 if the company does not exist or your integration does not have access to it.
Error Details:
- 404 Not Found — company does not exist or your integration does not have access to it
Authorization
XApiKey Your API key.
In: header
Path Parameters
The unique identifier of the company to retrieve.
int32Query Parameters
API version
"3.0""3.0"Response Body
curl -X GET "https://external-app-prod.netchexonline.net/companies/0?api-version=3.0"{
"id": 0,
"name": "string",
"code": "string",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"organizationName": "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 Companies GET
Returns a paginated list of companies. Each company belongs to an organization. **Optional Filters:** - `organization-ids` — limit to companies belonging to these organizations (max 100) - `company-ids` — limit to these companies (max 100) Multiple filters combine with AND logic; values within one parameter combine with OR. **Access control:** Results are limited to companies your integration has access to. When `organization-ids` is supplied, only companies 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 Department GET
Returns a single department by ID. The response includes the full parent hierarchy: organization → company → division → business unit → department. **Access control:** Returns 404 if the department does not exist or it belongs to a company your integration does not have access to. **Error Details:** - **404 Not Found** — department does not exist or belongs to a company your integration does not have access to