Stations
Manage workstations and bays that jobs can be assigned to
A station is a physical workstation or bay in your shop. Jobs reference a
station through their stationId, which lets you see what's being worked on
where.
Endpoints
- GET
/organisations/{orgId}/stations— List stations (ordered byindex) - POST
/organisations/{orgId}/stations— Create station - GET
/organisations/{orgId}/stations/{stationId}— Get station - PUT
/organisations/{orgId}/stations/{stationId}— Update station - DELETE
/organisations/{orgId}/stations/{stationId}— Delete station
Deleting a station in use
A station that is still assigned to an active (non-closed) job cannot be
deleted — the request returns 409 Conflict. Reassign or close those jobs
first.
API key for authentication. Get your key from the Developer Dashboard.
In: header
Path Parameters
Organisation ID
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/organisations/string/stations"{ "success": true, "data": { "stations": [ { "id": "string", "name": "string", "index": 0, "capacity": 0 } ] }}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "You do not have access to this organisation"}API key for authentication. Get your key from the Developer Dashboard.
In: header
Path Parameters
Organisation ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organisations/string/stations" \ -H "Content-Type: application/json" \ -d '{ "name": "Bench 1", "index": 0, "capacity": 1 }'{ "success": true, "data": { "id": "string", "name": "string", "index": 0, "capacity": 0 }}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "You do not have access to this organisation"}API key for authentication. Get your key from the Developer Dashboard.
In: header
Path Parameters
Organisation ID
Station ID
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/organisations/string/stations/string"{ "success": true, "data": { "id": "string", "name": "string", "index": 0, "capacity": 0 }}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "You do not have access to this organisation"}{ "success": false, "error": "An error occurred"}API key for authentication. Get your key from the Developer Dashboard.
In: header
Path Parameters
Organisation ID
Station ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/organisations/string/stations/string" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "data": { "id": "string", "name": "string", "index": 0, "capacity": 0 }}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "You do not have access to this organisation"}{ "success": false, "error": "An error occurred"}API key for authentication. Get your key from the Developer Dashboard.
In: header
Path Parameters
Organisation ID
Station ID
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/organisations/string/stations/string"{ "success": true, "data": { "message": "Operation completed successfully" }}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "You do not have access to this organisation"}{ "success": false, "error": "An error occurred"}{ "success": false, "error": "An error occurred"}Machine-readable version: OpenAPI 3.1 spec.