Skip to main content
GET
/
machines
/
{id}
Get a machine
curl --request GET \
  --url https://api.demo.cula.earth/tracking/v1/machines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cula-Organisation-Id: <cula-organisation-id>'
{
  "id": "mch_01kqzcjrpyf27tge6smsbnhkh5",
  "external_id": "GC-TRUCK-SCALE",
  "name": "Truck Scale",
  "site": {
    "id": "ste_01kqzcjrpyf27tge6smsbnhkh5",
    "external_id": "GC-SITE-REFINERY"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 client credentials flow. Exchange your client_id and client_secret for a short-lived access token, then pass it as a Bearer token in the Authorization header.

Headers

​
Cula-Organisation-Id
string
required

Organisation ID that scopes this request. The authenticated consumer must be authorized for this organisation. Omitting this header returns 400; passing an unauthorised org returns 403.

Path Parameters

​
id
string
required

Cula-assigned resource ID in TypeID format (e.g. stp_01kqzcjrpxf27tge33jwvjhkff). Alternatively, pass your external ID prefixed with ext- (e.g. ext-MY-STEP-001). The ext- prefix is unambiguous because TypeIDs use _ separators and never start with ext-.

Response

Machine details.

​
id
string
required
Example:

"mch_01kqzcjrpyf27tge6smsbnhkh5"

​
name
string
required
Example:

"Truck Scale"

​
site
object
required

The site this machine is installed at.