Version 2

Changelog:

• standardized response structure

• enabled multi-device for objects

• structure allows for adding additional details to devices

Get Object by ID

get

Retrieves details for a specific object based on its ID.

Required scopes

This endpoint requires the following scopes:

Authorizations

revtek-authorizer

AuthorizationstringRequired

Path parameters

object_idstringRequired

The unique identifier for the object.

Example: obj_building_123

Responses

200

Object details retrieved successfully.

application/json

404

Object not found for the given ID and client.

application/json

get

/objects/{object_id}

HTTPcURLJavaScriptPython

GET /v2/objects/{object_id} HTTP/1.1
Host: api-test.revtek.cloud
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 200,
  "message": "Object fetched successfully",
  "data": {
    "id": "obj_building_123",
    "type": "Building",
    "name": "Main Office Building"
  }
}

Get All Objects

get

Retrieves a list of all objects accessible by the client, including their devices.

Required scopes

This endpoint requires the following scopes:

Authorizations

revtek-authorizer

AuthorizationstringRequired

Responses

200

List of objects retrieved successfully.

application/json

404

No objects found for the client.

application/json

get

/objects

HTTPcURLJavaScriptPython

GET /v2/objects HTTP/1.1
Host: api-test.revtek.cloud
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 200,
  "message": "Objects fetched successfully",
  "data": {
    "objects": [
      {
        "id": "obj_building_123",
        "type": "Building",
        "name": "Main Office Building",
        "devices": [
          {
            "id": "dev_thermostat_01",
            "type": "Thermostat",
            "status": "Online"
          },
          {
            "id": "dev_light_05",
            "type": "Light",
            "status": "Offline"
          }
        ]
      },
      {
        "id": "obj_site_abc",
        "type": "Site",
        "name": "Branch Site ABC",
        "devices": []
      }
    ]
  }
}

Get Devices for Object

get

Retrieves a list of devices associated with a specific object.

Required scopes

This endpoint requires the following scopes:

Authorizations

revtek-authorizer

AuthorizationstringRequired

Path parameters

object_idstringRequired

The unique identifier for the object.

Example: obj_building_123

Responses

200

List of devices retrieved successfully.

application/json

404

No devices found for the object.

application/json

get

/objects/{object_id}/devices

HTTPcURLJavaScriptPython

GET /v2/objects/{object_id}/devices HTTP/1.1
Host: api-test.revtek.cloud
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 200,
  "message": "Devices fetched successfully",
  "data": {
    "id": "obj_building_123",
    "type": "Building",
    "name": "Main Office Building",
    "devices": [
      {
        "id": "dev_thermostat_01",
        "type": "Thermostat",
        "name": "Office Thermostat",
        "status": "Online"
      },
      {
        "id": "dev_light_05",
        "type": "Light",
        "name": "Meeting Room Light",
        "status": "Offline"
      }
    ]
  }
}

Get Device by ID

get

Retrieves details for a specific device within an object.

Required scopes

This endpoint requires the following scopes:

Authorizations

revtek-authorizer

AuthorizationstringRequired

Path parameters

device_idstringRequired

The unique identifier for the device.

Example: dev_thermostat_01

object_idstringRequired

The unique identifier for the object containing the device.

Example: obj_building_123

Responses

200

Device details retrieved successfully.

application/json

404

Device not found for the given ID and client.

application/json

get

/objects/{object_id}/devices/{device_id}

HTTPcURLJavaScriptPython

GET /v2/objects/{object_id}/devices/{device_id} HTTP/1.1
Host: api-test.revtek.cloud
Authorization: YOUR_API_KEY
Accept: */*

{
  "status": 200,
  "message": "Device status fetched successfully",
  "data": {
    "id": "dev_thermostat_01",
    "type": "Thermostat",
    "name": "Office Thermostat",
    "status": "Online"
  }
}

Send 'open' Action to Device

post

Sends an 'open' command action to a specific device.

Required scopes

This endpoint requires the following scopes:

Authorizations

revtek-authorizer

AuthorizationstringRequired

Path parameters

device_idstringRequired

The unique identifier for the device.

Example: dev_doorlock_1A

object_idstringRequired

The unique identifier for the object containing the device.

Example: obj_building_123

Body

application/json

actionstring · enumRequired

The action to perform.

Possible values:

Responses

200

Action command successfully executed.

application/json

400

Invalid request body or unknown command.

application/json

401

Unauthorized. Missing client_id or no matching record found for the client and device.

application/json

post

/objects/{object_id}/devices/{device_id}/actions

HTTPcURLJavaScriptPython

POST /v2/objects/{object_id}/devices/{device_id}/actions HTTP/1.1
Host: api-test.revtek.cloud
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "action": "open"
}

{
  "message": "Command executed successfully"
}