v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Machine

Get a list of machines for the specified business id and branch id. List can be filtered by DateTime of update with a possibility to include archived machines

List machines

get/api/business/{businessId}/branch/{branchId}/machine

Path parameters

businessIdstring required
branchIdstring required

Query parameters

include_archivedboolean

include archived machines in the list

updated_fromstring

date-time from which the machines have been updated onwards

updated_tostring

date-time to which the machines has been updated backwards

number of machines to return, max is 100

page number, default is 0 and is optional

Response

Machines listed

Example response

{
  "_embedded": {
    "machines": [
      {
        "machineId": "ab-123",
        "name": "123456",
        "description": "The machine description"
      }
    ]
  }
}