Skip to content

Get Machines

Retrieves a set of machines.

Verb POST
Endpoint {base-url}/machines/settings
Max Page Size 50

Request Body

{
  "requestFilter": {
    "organizationIds": [],
    "accountIds": [],
    "siteIds": [],
    "machineIdentifiers": [],
    "includeDeleted": false
  }
}

Filters Honored

  • RequestFilter
    • organizationIds
    • accountIds
    • siteIds
    • machineIdentifiers
    • includeDeleted
  • SettingsFilter
    • includeInactive
    • groupIds
    • settingsIds

Returns

On Success

The requested list of settings.

Response Body

[
  {
    "id": 1, // do not include for records being created
    "machineId": 402,
    "settings": "arsarsa 3: the harrowing",
    "isActive": true,
    "isCurrent": true,
    "type": "asairens",
    "createdAt": "023-08-07T02:44:14.887"
  }
]