API management
Prerequisites
- InduSuite account with main administrator access (API management is admin-only)
- API key from the Settings > Company settings > API management page
- A REST-capable client (curl, Postman, Python requests, etc.)
How to Run
- Navigate to Settings > Company settings in InduSuite.

- If you lack admin rights, you'll be notified and cannot proceed.

- In the API management view, copy your API key. Do NOT share it with unauthorized parties.

- Use the key as a Bearer token or header parameter in your API calls.
API Endpoints
Three endpoints are currently available:
Endpoint | URL | Purpose |
|---|---|---|
Devices | Welding equipment | |
Personnel | Personnel members | |
Weld Sessions | Weld session data |
Each endpoint has detailed documentation with required parameters.

Examples
For hands-on examples with screenshots, see related skills:
- api-get-devices-guide — Get all connected devices
- api-get-personnel-guide — Get personnel member ID and JSON payload
JSON Payload Example
When updating personnel via API, you need the complete JSON payload:
{
"id": "03783141-ed39-4949-9e78-0a2a4e9b6320",
"displayName": "Sample Welder",
"sites": ["Welding Department"],
"email": null,
"firstName": "Sample",
"secondName": "Welder",
"operatorId": "DD8175",
"operatorUsername": "",
"nfcId": "",
"language": "en-GB",
"unitOfMeasurement": "metric",
"stamp": "SW706",
"isActive": true,
"activeUntil": null,
"roles": ["Fitter"],
"isDeleted": false
}To add a Welder role, change the roles array to ["Fitter", "Welder"] and send the complete payload via the update API call.
Updated on: 19/08/2026
Thank you!
