Get support

Devices

List

get
/devices

Get a list of devices of a given team.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
teamIdintegerRequiredExample: 1
assignedbooleanOptional

true = devices with scenarioId; false = devices without scenarioId - this filter only affects the trigger scope

Example: true
viewForScenarioIdintegerOptional

Devices assigned to the scenario and not assigned devices. If this parameter is set assigned parameter is ignored.

Example: 4
Responses
200

Successful response

application/json
get
/devices
GET /api/v2/devices?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "devices": [
    {
      "id": 2,
      "name": "Phone",
      "teamId": 2,
      "udid": "XboVPMTfgtwBNjRr7AGPe9X4AdRZhkaF",
      "scope": [
        "call",
        "scaner"
      ],
      "info": null,
      "queueCount": 0,
      "queueLimit": 10000,
      "scenarioId": null
    }
  ]
}

Detail

get
/devices/{deviceId}

The ID can be id or udid.

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
deviceIdintegerRequired
Query parameters
inspectorintegerOptionalExample: 1
Responses
200

Successful response

application/json
get
/devices/{deviceId}
GET /api/v2/devices/{deviceId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "device": {
    "id": 2,
    "name": "Phone",
    "teamId": 2,
    "udid": "XboVPMTfgtwBNjRr7AGPe9X4AdRZhkaF",
    "scope": [
      "call",
      "scaner"
    ],
    "info": null,
    "queueCount": 0,
    "queueLimit": 10000,
    "scenarioId": null
  }
}

Delete

delete
/devices/{deviceId}

Errors: IM004 - Confirmation required (error with metadata) - needs confirmation IM405 - Device can't be deleted because it contains messages in queue (error with metadata) - needs confirmation IM005 - Device is locked by a running scenario and thus can't be deleted

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
deviceIdstringRequiredExample: 2
Query parameters
confirmedbooleanOptionalExample: true
Responses
200

Successful response

application/json
delete
/devices/{deviceId}
DELETE /api/v2/devices/{deviceId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "device": 2
}

Partial update

patch
/devices/{deviceId}

Update a device

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
deviceIdstringRequired
Query parameters
Body
objectOptional
Responses
200

Successful response

application/json
patch
/devices/{deviceId}
PATCH /api/v2/devices/{deviceId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "name": "Android phone"
}
200

Successful response

{
  "device": {
    "id": 2,
    "name": "Android phone",
    "teamId": 2,
    "udid": "XboVPMTfgtwBNjRr7AGPe9X4AdRZhkaF",
    "scope": [
      "call",
      "scaner"
    ],
    "info": null,
    "queueCount": 0,
    "queueLimit": 10000,
    "scenarioId": null
  }
}

Create request

post
/devices/request

Required scope: devices:write

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters
inspectorintegerOptionalExample: 1
Body
namestringOptional
teamIdintegerOptional
Responses
200

Successful response

application/json
post
/devices/request
POST /api/v2/devices/request HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "name": "Phone",
  "teamId": 1
}
200

Successful response

{
  "createDeviceRequest": {
    "udid": "k1KqeAVIYA5Rq5vduiU3mUfbGD4vhTfH",
    "inspector": true
  }
}
PreviousData structuresNextDevices > Incomings

Last updated