List Machines

Beta

GET/v1/operations/machines

This endpoint is idempotent. Learn more

Returns a paginated list of machines in your account, most recently created first.

The search term matches the start of the machine name, and a machine named exactly the term is listed first.

Permission requiredValues:machines:read

The role behind your API key or agent must grant this permission.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page. Defaults to 100.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

include[]optional arrayenumValues:department

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of machine

Resources in this page.

idstring

Machine ID.

objectstringenumValues:machine

Resource type identifier.

namestring

Display name of the machine.

Unique within the account.

serial_numberstring

Serial number of the machine.

notesstringnullable

Free-form notes about the machine.

departmentdepartmentExpandablenullable

The department this machine belongs to.

Set when the machine is created; a machine cannot be moved to another department afterwards.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name of the department.

Unique within the account.

notesstringnullable

Free-form notes about the department.

locationlocationnullable

The storage location where this department operates.

Always returned as null in this endpoint.

scanning_stationslistnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machineslistnullable

Machines in this department.

Always returned as null in this endpoint.

labor_rateratenullable

Hourly labor rate for work done in this department, such as a changeover technician.

Production scheduling costs changeovers with the constraint department's rate when one is set, falling back to the account-wide changeover labor rate setting.

Null unless the caller holds costs:read; customer and supplier portal users never see it.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Machines

List Machines

import OpenMRP from '@openmrp/sdk';

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

const listMachine = await client.operations.machines.list();

console.log(listMachine.data);

import OpenMRP from '@openmrp/sdk';

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

const listMachine = await client.operations.machines.list();

console.log(listMachine.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/machines?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibWNfZmZjZms5ZHhpeGlzIiwiZCI6ImYifQ.ezyHho763BNFhG8RuG7P5Bvrp3eshI0LSeefnLBdY-A",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "mc_ffcfk9dxixis",
      "object": "machine",
      "name": "CNC Router",
      "serial_number": "SN-2024-0001",
      "notes": "Spindle rebuilt March 2026; torque calibration due quarterly.",
      "department": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/machines?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibWNfZmZjZms5ZHhpeGlzIiwiZCI6ImYifQ.ezyHho763BNFhG8RuG7P5Bvrp3eshI0LSeefnLBdY-A",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "mc_ffcfk9dxixis",
      "object": "machine",
      "name": "CNC Router",
      "serial_number": "SN-2024-0001",
      "notes": "Spindle rebuilt March 2026; torque calibration due quarterly.",
      "department": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Machines

Authorization

Query Parameters

Returns

Responses