List Machine Status

Beta

GET/v1/operations/machine-status

This endpoint is idempotent. Learn more

Returns what every machine is running right now, how much is left on it, and what is queued behind that.

Assembled from the published schedule, the batches the floor has scanned against each campaign, and any open downtime. A campaign is current once its week is released and while it still has batches to scan; when the last one is scanned it hands over to the next, so this advances on its own as a shift progresses.

A machine with an open stoppage reads down even when it has a released campaign, because a broken machine is not producing whatever the plan says. A machine with nothing released reads idle, which is a state worth seeing rather than an absence from the list.

Reads the published version rather than the newest draft: the floor works to what was committed, and a draft regenerating underneath a wall display would make machines appear to change job on their own. With nothing published every machine reads idle rather than the request failing.

Permissions requiredValues:machines:read

The role behind your API key or agent must grant every one of these permissions.

department_ids[]optional array

Only include machines in these departments.

as_ofoptional string (date-time)

The moment to read the floor at. Defaults to now.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of machine_status

Resources in this page.

objectstringenumValues:machine_status

Resource type identifier.

machineentitynullable

The machine.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

departmententitynullable

The department the machine belongs to.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

statusstringenumValues:runningidledown

What the machine is doing.

running: a released campaign with work still to scan.
idle: nothing released to it.
down: an open downtime event, which outranks running.

downtimeobjectnullable

The open stoppage, when the machine is down.

evententitynullable

The downtime event.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

reasonmachine_downtime_reasonnullable

Why the machine stopped.

objectstringenumValues:machine_downtime_reason

Resource type identifier.

codestringenumValues:breakdownchangeovermaterial_shortage

Stable code identifying the reason.

namestringnullable

Display name of the reason.

oee_bucketstringnullableenumValues:availabilityperformancequality

Which OEE term this reason charges.

started_atstring (date-time)

When the machine went down.

notestringnullable

Free-text note left by whoever logged it.

currentobjectnullable

The campaign being worked: the earliest released one with batches still to scan.

schedule_lineentitynullable

The schedule line this campaign came from.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

itementitynullable

The item being made.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

skustring

SKU of the item.

week_starts_atstring (date-time)

First day of the week the campaign belongs to.

week_indexinteger

Zero-based week offset from the start of the horizon.

planned_quantitynumber

Quantity the plan asked for.

scanned_quantitynumber

Quantity the floor has scanned so far.

remaining_quantitynumber

Quantity still to make.

Never negative: an over-run shows up in scanned_quantity rather than as negative remaining work.

unitstringnullable

Unit the quantities are counted in.

released_batch_countinteger

Batches issued to the floor for this campaign.

scanned_batch_countinteger

Batches of this campaign the floor has scanned.

planned_run_hoursnumber

Constraint hours the campaign consumes.

statusstringenumValues:plannedreleasedin_progress

Where the campaign is in its lifecycle.

production_runentitynullable

The run carrying this campaign's work, once its week has been released.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

nextobjectnullable

What follows, so an operator can set up for it.

schedule_lineentitynullable

The schedule line this campaign came from.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

itementitynullable

The item being made.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

skustring

SKU of the item.

week_starts_atstring (date-time)

First day of the week the campaign belongs to.

week_indexinteger

Zero-based week offset from the start of the horizon.

planned_quantitynumber

Quantity the plan asked for.

scanned_quantitynumber

Quantity the floor has scanned so far.

remaining_quantitynumber

Quantity still to make.

Never negative: an over-run shows up in scanned_quantity rather than as negative remaining work.

unitstringnullable

Unit the quantities are counted in.

released_batch_countinteger

Batches issued to the floor for this campaign.

scanned_batch_countinteger

Batches of this campaign the floor has scanned.

planned_run_hoursnumber

Constraint hours the campaign consumes.

statusstringenumValues:plannedreleasedin_progress

Where the campaign is in its lifecycle.

production_runentitynullable

The run carrying this campaign's work, once its week has been released.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

week_planned_quantitynumber

Planned for this machine this week.

week_scanned_quantitynumber

Scanned on this machine this week.

week_planned_run_hoursnumber

Constraint hours planned on this machine this week.

unitstringnullable

Unit the week's quantities are counted in.

Responses

200

Successful response for List Machine Status

List Machine Status

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listMachineStatus = await client.operations.retrieveMachineStatus();

console.log(listMachineStatus.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listMachineStatus = await client.operations.retrieveMachineStatus();

console.log(listMachineStatus.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "machine_status",
      "machine": {
        "id": "mc_0177d18f55a1615f783d3bf8d0",
        "object": "entity",
        "type": "machine",
        "name": "Merz 1",
        "handle": null
      },
      "department": null,
      "status": "running",
      "downtime": null,
      "current": {
        "schedule_line": {
          "id": "pnscln_0192a4c17b3e4f8a91c2",
          "object": "entity",
          "type": "production_schedule_line",
          "name": null,
          "handle": null
        },
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": "MZ-GREIGE-CREW"
        },
        "sku": "MZ-GREIGE-CREW",
        "week_starts_at": "2026-05-10T00:00:00Z",
        "week_index": 0,
        "planned_quantity": 360,
        "scanned_quantity": 120,
        "remaining_quantity": 240,
        "unit": "pr",
        "released_batch_count": 6,
        "scanned_batch_count": 2,
        "planned_run_hours": 60,
        "status": "released",
        "production_run": null
      },
      "next": null,
      "week_planned_quantity": 360,
      "week_scanned_quantity": 120,
      "week_planned_run_hours": 60,
      "unit": "pr"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "machine_status",
      "machine": {
        "id": "mc_0177d18f55a1615f783d3bf8d0",
        "object": "entity",
        "type": "machine",
        "name": "Merz 1",
        "handle": null
      },
      "department": null,
      "status": "running",
      "downtime": null,
      "current": {
        "schedule_line": {
          "id": "pnscln_0192a4c17b3e4f8a91c2",
          "object": "entity",
          "type": "production_schedule_line",
          "name": null,
          "handle": null
        },
        "item": {
          "id": "it_0131e386ac683e8c29a71f6f1f",
          "object": "entity",
          "type": "item",
          "name": null,
          "handle": "MZ-GREIGE-CREW"
        },
        "sku": "MZ-GREIGE-CREW",
        "week_starts_at": "2026-05-10T00:00:00Z",
        "week_index": 0,
        "planned_quantity": 360,
        "scanned_quantity": 120,
        "remaining_quantity": 240,
        "unit": "pr",
        "released_batch_count": 6,
        "scanned_batch_count": 2,
        "planned_run_hours": 60,
        "status": "released",
        "production_run": null
      },
      "next": null,
      "week_planned_quantity": 360,
      "week_scanned_quantity": 120,
      "week_planned_run_hours": 60,
      "unit": "pr"
    }
  ]
}

List Machine Status

Authorization

Query Parameters

Returns

Responses