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 machine name.

Permissions requiredValues:machines:read
The role behind your API key or agent must grant every one of these permissions.
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.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

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.

departmentdepartmentnullable

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.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of location

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

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 location

Resources in this page.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name of the location.

typeobject

This location's level in the storage hierarchy.

The levels run from largest to smallest: building, section, aisle, rack, shelf, bin. They are descriptive labels rather than a rule — a location's parent is not required to be the next level up.

parentlocationnullable

The location directly above this one in the storage hierarchy.

Absent for top-level locations.

childrenlistnullable

The locations directly below this one in the storage hierarchy.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

scanning_stationslistnullable

Scanning stations in this department.

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 scanning_station

Resources in this page.

idstring

Scanning station ID.

objectstringenumValues:scanning_station

Resource type identifier.

namestring

Display name of the scanning station.

Unique within the account.

notesstringnullable

Free-form notes about the scanning station.

typestringenumValues:init_batchmerge_batchmove_batch

Scanning station type, determining which batch operation an operator performs when they scan here.

  • init_batch: starts a new batch at the beginning of a production flow.
  • merge_batch: combines several scanned batches into one.
  • move_batch: advances a batch through a production step connected to this station.
  • split_batch: divides a batch into several batches.

Fixed when the station is created.

label_sizestringnullableenumValues:1x11x31x4

Size of the labels printed at this station, given as width-by-height (for example, 1x1).

label_typestringnullableenumValues:tagtraveler

Type of label printed at this station.

  • tag: a label attached to the physical product.
  • traveler: a routing sheet that accompanies the batch through every production step.
operator_requirementstringenumValues:nonematerial_check

Whether operators must perform a material check at this station.

  • none: no additional operator check is required.
  • material_check: a material check is expected before the operation.
departmentdepartmentnullable

The department this scanning station belongs to.

Assigned when the station is created and cannot be reassigned afterward.

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.

scanning_stationslistnullable

Scanning stations in this department.

machineslistnullable

Machines in this department.

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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

production_stepslistnullable

Production steps connected to this station.

A production step can be connected to at most one scanning station, so connecting a step here disconnects it from any other station. Manage the connections with Connect Production Steps to Scanning Station.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

dataarray of production_step

Resources in this page.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

machineslistnullable

Machines in this department.

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.

departmentdepartmentnullable

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.

scanning_stationslistnullable

Scanning stations in this department.

machineslistnullable

Machines in this department.

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.

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.

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.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

  • system: a platform-provided default shared across all accounts; not editable.
  • account: created and owned by a specific account; the account field identifies which.
accountaccountnullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

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