Devices

Device lifecycle and management

Get devices in organization

get

Retrieve a paginated list of devices in an organization.

Required permissions, when user-scoped authentication is used: ORG_DEVICES_VIEW.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

orgIdinteger · int32Optional

Organization ID (optional, defaults to the organization, associated with the authentication token)

includeSubOrgDevicesbooleanOptional

Include devices from sub-organizations

Default: false

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

List of devices

application/json

totalElementsinteger · int64Required

Total amount of devices, available to fetch.

Example: 1

400

Bad request - requested page size is too big

application/json

403

Forbidden

404

Organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/devices

GET /api/v1/organization/devices HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 1,
      "name": "Living Room Sensor",
      "templateId": 101,
      "orgId": 101,
      "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
      "activatedAt": 1707244800000,
      "ownerUserId": 202,
      "hardwareInfo": {
        "version": "1.0.0",
        "fwType": "TMPL8RITg_f9Q",
        "blynkVersion": "1.0.0",
        "boardType": "Arduino",
        "build": "10 Jan 2025",
        "templateId": "TMPL8RITg_f9Q"
      }
    }
  ],
  "totalElements": 1
}

Search devices

get

Search for devices by the provided query.

Required permissions, when user-scoped authentication is used: ORG_DEVICES_VIEW.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

querystring · max: 255Required

Search query string

sortBystringOptional

Field to sort by

sortOrderstring · enumOptional

Sort order

Default: ASCPossible values:

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

Search results

application/json

totalElementsinteger · int64Required

Total amount of devices, available to fetch.

Example: 1

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/search/devices

GET /api/v1/organization/search/devices?query=text HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 1,
      "name": "Living Room Sensor",
      "templateId": 101,
      "orgId": 101,
      "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
      "activatedAt": 1707244800000,
      "ownerUserId": 202,
      "hardwareInfo": {
        "version": "1.0.0",
        "fwType": "TMPL8RITg_f9Q",
        "blynkVersion": "1.0.0",
        "boardType": "Arduino",
        "build": "10 Jan 2025",
        "templateId": "TMPL8RITg_f9Q"
      }
    }
  ],
  "totalElements": 1
}

Get device by ID

get

Retrieve detailed information about a specific device including current datastream values.

Required permissions, when user-scoped authentication is used: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can access only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

200

Device details

application/json

400

Bad request - invalid device ID

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device

GET /api/v1/organization/device?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "name": "Living Room Sensor",
  "templateId": 101,
  "orgId": 101,
  "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
  "activatedAt": 1707244800000,
  "ownerUserId": 202,
  "hardwareInfo": {
    "version": "1.0.0",
    "fwType": "TMPL8RITg_f9Q",
    "blynkVersion": "1.0.0",
    "boardType": "Arduino",
    "build": "10 Jan 2025",
    "templateId": "TMPL8RITg_f9Q"
  },
  "lifecycleStatus": {
    "eventId": 1,
    "name": "Online",
    "color": "#80d456",
    "icon": "\\ue8b7"
  },
  "firstConnectTime": 1707244800000,
  "firmwareUpdatedAt": 1707244800000,
  "connectTime": 1707244800000,
  "disconnectTime": 1707244800000,
  "ip": "89.23.12.10",
  "lastReceivedEventAt": 1707244800000,
  "lastReportedAt": 1707244800000,
  "dataStreamValues": [
    {
      "dataStreamId": 201,
      "pin": "v10",
      "dataStreamLabel": "Temperature_Sensor",
      "dataStreamAlias": "Temperature Sensor",
      "value": "Some DataStream Value",
      "updatedAt": 1707245800000
    }
  ],
  "metaFieldValues": [
    {
      "id": 1,
      "name": "text",
      "isMandatory": true,
      "includeInProvision": true,
      "value": {
        "type": "MultiText",
        "values": [
          "SN-001",
          "SN-002"
        ]
      }
    }
  ]
}

Update device

put

Update device properties (e.g., name).

Required permissions, when user-scoped authentication is used: ORG_DEVICES_EDIT. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can update only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Body

namestring · min: 1 · max: 50Required

New device name. Only letters, digits, spaces, apostrophes, underscores and hyphens are allowed.

Responses

200

Device updated successfully

application/json

idinteger · int32Required

Device ID

Example: 1

namestringRequired

Device name

Example: Living Room Sensor

templateIdinteger · int32Required

Template ID this device belongs to

Example: 101

orgIdinteger · int32Required

Organization ID this device belongs to

Example: 101

tokenstringRequired

Device authentication token

Example: ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm

activatedAtinteger · int64Optional

Device activation timestamp

Example: 1707244800000

ownerUserIdinteger · int64Optional

Device owner identifier

Example: 202

400

Bad request

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

put

/api/v1/organization/device

PUT /api/v1/organization/device?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": 1,
  "name": "Living Room Sensor",
  "templateId": 101,
  "orgId": 101,
  "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
  "activatedAt": 1707244800000,
  "ownerUserId": 202,
  "hardwareInfo": {
    "version": "1.0.0",
    "fwType": "TMPL8RITg_f9Q",
    "blynkVersion": "1.0.0",
    "boardType": "Arduino",
    "build": "10 Jan 2025",
    "templateId": "TMPL8RITg_f9Q"
  }
}

Delete device

delete

Delete a device and all associated data

Required permissions, when user-scoped authentication is used: ORG_DEVICES_DELETE. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can delete only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

204

Device deleted successfully

400

Bad request

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

delete

/api/v1/organization/device

DELETE /api/v1/organization/device?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get device base info

get

Retrieve basic device information (minimized version without all details).

Required permissions, when user-scoped authentication is used: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can access only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

200

Device details

application/json

400

Bad request - invalid device ID

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/baseInfo

GET /api/v1/organization/device/baseInfo?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "name": "Living Room Sensor",
  "templateId": 101,
  "orgId": 101,
  "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
  "activatedAt": 1707244800000,
  "ownerUserId": 202,
  "hardwareInfo": {
    "version": "1.0.0",
    "fwType": "TMPL8RITg_f9Q",
    "blynkVersion": "1.0.0",
    "boardType": "Arduino",
    "build": "10 Jan 2025",
    "templateId": "TMPL8RITg_f9Q"
  },
  "lifecycleStatus": {
    "eventId": 1,
    "name": "Online",
    "color": "#80d456",
    "icon": "\\ue8b7"
  },
  "firstConnectTime": 1707244800000,
  "firmwareUpdatedAt": 1707244800000,
  "connectTime": 1707244800000,
  "disconnectTime": 1707244800000,
  "ip": "89.23.12.10",
  "lastReceivedEventAt": 1707244800000,
  "lastReportedAt": 1707244800000
}

Create a new device

post

Create a new device from a template.

Required permissions, when user-scoped authentication is used: ORG_DEVICES_CREATE. User-scoped tokens that set ownerId different from authenticated user ID also require ORG_VIEW_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

baseInfoResponsebooleanOptional

Flag, indicating whether server should respond only with base info

Default: false

Body

templateIdstring · max: 200Required

Template ID for the device

Example: TMPL8RITg_f9Q

orgIdinteger · int32Optional

Organization ID (optional). If none is specified, the device is being created in the organization associated with the authentication token.

Example: 101

namestring · max: 50Required

Device name. Only letters, digits, spaces, apostrophes, underscores and hyphens are allowed.

Example: Temperature Sensor

ownerIdinteger · int64Optional

Owner user ID (optional)

Example: 101

Responses

201

Device created successfully

application/json

400

Bad request

application/json

403

Forbidden

404

Template/user/organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/device/create

POST /api/v1/organization/device/create HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "templateId": "TMPL8RITg_f9Q",
  "orgId": 101,
  "name": "Temperature Sensor",
  "ownerId": 101
}

{
  "id": 1,
  "name": "Living Room Sensor",
  "templateId": 101,
  "orgId": 101,
  "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
  "activatedAt": 1707244800000,
  "ownerUserId": 202,
  "hardwareInfo": {
    "version": "1.0.0",
    "fwType": "TMPL8RITg_f9Q",
    "blynkVersion": "1.0.0",
    "boardType": "Arduino",
    "build": "10 Jan 2025",
    "templateId": "TMPL8RITg_f9Q"
  },
  "lifecycleStatus": {
    "eventId": 1,
    "name": "Online",
    "color": "#80d456",
    "icon": "\\ue8b7"
  },
  "firstConnectTime": 1707244800000,
  "firmwareUpdatedAt": 1707244800000,
  "connectTime": 1707244800000,
  "disconnectTime": 1707244800000,
  "ip": "89.23.12.10",
  "lastReceivedEventAt": 1707244800000,
  "lastReportedAt": 1707244800000,
  "dataStreamValues": [
    {
      "dataStreamId": 201,
      "pin": "v10",
      "dataStreamLabel": "Temperature_Sensor",
      "dataStreamAlias": "Temperature Sensor",
      "value": "Some DataStream Value",
      "updatedAt": 1707245800000
    }
  ],
  "metaFieldValues": [
    {
      "id": 1,
      "name": "text",
      "isMandatory": true,
      "includeInProvision": true,
      "value": {
        "type": "MultiText",
        "values": [
          "SN-001",
          "SN-002"
        ]
      }
    }
  ]
}

Get device online status

get

Check whether a device is currently connected to the server over MQTT or Blynk Protocol.

Required permissions, when user-scoped authentication is used: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can read status only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

200

Device online status

application/json

connectedbooleanOptional

Whether the device is currently connected

400

Bad request - invalid device ID

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/online

GET /api/v1/organization/device/online?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "connected": true
}

Get device tags

get

Retrieve all tags assigned to a device

Required permissions, when user-scoped authentication is used: VIEW_OWN_ORG_TAG. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can read tags only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

200

List of device tags

application/json

idinteger · int32Required

Tag ID

Example: 1

namestringRequired

Tag name

Example: In Service

tagOwnerOrgIdinteger · int32Required

ID of the organization, that created the tag

Example: 1

400

Bad request - invalid device ID

application/json

403

Forbidden

404

Device not found

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/tags

GET /api/v1/organization/device/tags?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "In Service",
    "tagOwnerOrgId": 1
  }
]

Get device timeline

get

Retrieve device activity timeline (events and lifecycle changes).

It may take up to a minute for new events to appear in the timeline. Timeline is sorted in reverse chronological order (most recent events first).

Required permissions, when user-scoped authentication is used: VIEW_TIMELINE. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can read timeline only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

eventTypestring · enumOptional

Filter by event type (optional)

Possible values:

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

Device timeline events

application/json

totalElementsinteger · int64Required

Total amount of timeline events, available to fetch.

Example: 1

400

Bad request

application/json

403

Forbidden

404

Device not found

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/timeline

GET /api/v1/organization/device/timeline?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 101,
      "eventId": 1,
      "orgId": 101,
      "eventType": "ONLINE",
      "description": "Temperature is 30.5°C",
      "ts": 1707245800000,
      "isResolved": true,
      "resolvedAt": 1707246800000,
      "resolvedComment": "Temperature back to normal"
    }
  ],
  "totalElements": 1
}

Get device logs

get

Retrieve device logs related to user actions. This endpoint returns logs of datastream updates that were performed by users (not by the device itself). Actions initiated by the device are not included.

It may take up to a minute for new log entries to appear in the logs list. Logs are sorted in reverse chronological order (most recent entries first).

Required permissions, when user-scoped authentication is used: ORG_DEVICE_VIEW_ACTION_LOG. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can read logs only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

Device logs

application/json

totalElementsinteger · int64Optional

Total amount of log entries, available to fetch.

Example: 1

400

Bad request

application/json

403

Forbidden

404

Device not found

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/logs

GET /api/v1/organization/device/logs?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "triggerUserEmail": "[email protected]",
      "value": 23.5,
      "pin": 2,
      "pinType": "VIRTUAL",
      "isOnline": true,
      "createdAt": 1625247600000
    }
  ],
  "totalElements": 1
}

Transfer device to a new owner

post

Transfer device ownership to a new owner user. The user must exist and be activated.

Required permissions, when user-scoped authentication is used: TRANSFER_DEVICE. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens that set newUserId different from authenticated user ID also require ORG_VIEW_USERS. User-scoped tokens can transfer only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

deviceIdinteger · int32Required

Device ID to transfer

Example: 101

newOwnerUserIdinteger · int64Required

New owner user ID

Example: 101

Responses

204

Device transferred successfully

400

Bad request - Invalid request body

application/json

403

Forbidden

404

Device/organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/device/transfer/to-owner

POST /api/v1/organization/device/transfer/to-owner HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "deviceId": 101,
  "newOwnerUserId": 101
}

No content

Transfer device to a new organization

post

Transfer a device to another organization without assigning a new owner.

Required permissions, when user-scoped authentication is used: TRANSFER_DEVICE, ORG_VIEW. Additionally, required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can transfer only owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

deviceIdinteger · int32Required

Device ID to transfer

Example: 101

newOrgIdinteger · int32Required

New organization ID

Example: 101

Responses

204

Device transferred successfully

400

Bad request - Invalid request body

application/json

403

Forbidden

404

Device/organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/device/transfer/to-organization

POST /api/v1/organization/device/transfer/to-organization HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "deviceId": 101,
  "newOrgId": 101
}

No content

Remove device owner

delete

Remove the current owner from a device

Required permissions, when user-scoped authentication is used: ORG_DEVICES_EDIT. Required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can remove owner only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

204

Device owner removed successfully

400

Bad request

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

delete

/api/v1/organization/device/owner

DELETE /api/v1/organization/device/owner?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Clear device data

delete

Clear all device data, including datastream history values and timeline.

Required permissions, when user-scoped authentication is used: ORG_DEVICE_DATA_DELETE. Required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can clear data only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

204

Device data cleared successfully

400

Bad request

application/json

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

delete

/api/v1/organization/device/clear

DELETE /api/v1/organization/device/clear?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Trigger device event

post

Manually trigger a device event.

The event may be muted if a notification schedule is configured and the current time falls outside the allowed window. A per-device rate limit applies to log events.

Required permissions, when user-scoped authentication is used: ORG_DEVICES_CONTROL. Required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can trigger events only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

deviceIdinteger · int32Required

Device ID

Example: 101

eventCodestring · max: 200Required

Event code to trigger

Example: high_temperature

eventDescriptionstring · max: 200Optional

Optional event description

Example: Temperature exceeded 22.0C threshold

Responses

204

Event triggered successfully

400

Bad request

application/json

403

Forbidden

404

Device/event not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/device/trigger-event

POST /api/v1/organization/device/trigger-event HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "deviceId": 101,
  "eventCode": "high_temperature",
  "eventDescription": "Temperature exceeded 22.0C threshold"
}

No content

Get devices by owner

get

Retrieve all devices owned by a specific user

When querying ownerEmail equal to authenticated user email (user-scoped auth), requires at least one of: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. When querying another ownerEmail with user-scoped auth, requires both ORG_VIEW_USERS and ORG_DEVICES_VIEW.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

ownerEmailstring · emailRequired

Owner email address

orgIdinteger · int32Optional

Organization ID (optional)

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

List of devices

application/json

totalElementsinteger · int64OptionalExample: 1

400

Bad request

application/json

403

Forbidden

404

Organization/User not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/by-owner

GET /api/v1/organization/device/by-owner?ownerEmail=name%40gmail.com HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 1,
      "name": "Living Room Sensor",
      "templateId": 101,
      "orgId": 101,
      "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
      "activatedAt": 1707244800000,
      "ownerUserId": 202,
      "hardwareInfo": {
        "version": "1.0.0",
        "fwType": "TMPL8RITg_f9Q",
        "blynkVersion": "1.0.0",
        "boardType": "Arduino",
        "build": "10 Jan 2025",
        "templateId": "TMPL8RITg_f9Q"
      }
    }
  ],
  "totalElements": 1
}

Get devices by user and organization

get

Retrieve devices accessible by a specific user in their organization

Required permissions, when user-scoped authentication is used: ORG_DEVICES_VIEW. User-scoped tokens querying userEmail different from authenticated user email also require ORG_VIEW_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

userEmailstring · emailRequired

User email address

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

List of devices

application/json

totalElementsinteger · int64OptionalExample: 1

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/by-user-org

GET /api/v1/organization/device/by-user-org?userEmail=name%40gmail.com HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 1,
      "name": "Living Room Sensor",
      "templateId": 101,
      "orgId": 101,
      "token": "ZJW2kImth5rGzPUBVcSPkqS_YsoFEFJm",
      "activatedAt": 1707244800000,
      "ownerUserId": 202,
      "hardwareInfo": {
        "version": "1.0.0",
        "fwType": "TMPL8RITg_f9Q",
        "blynkVersion": "1.0.0",
        "boardType": "Arduino",
        "build": "10 Jan 2025",
        "templateId": "TMPL8RITg_f9Q"
      }
    }
  ],
  "totalElements": 1
}

Get last activated devices

get

Retrieve recently activated devices in the organization

Required permissions, when user-scoped authentication is used: ORG_DEVICES_VIEW.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

orgIdinteger · int32Optional

Organization ID (optional). If not specified, the endpoint will return recently activated devices in the organization, that is associated with the authentication token.

minutesinteger · int32 · min: 1 · max: 60Optional

Time window in minutes for "recent" activations

Default: 5

Responses

200

List of activated devices

application/json

idinteger · int32Required

Device ID

Example: 101

orgIdinteger · int32Required

Organization ID

Example: 9

templateIdinteger · int32Required

Template ID

Example: 201

ownerUserIdinteger · int64Optional

User ID of the device owner

Example: 202

activationTimeinteger · int64Required

Device activation timestamp

Example: 1707244800000

403

Forbidden

404

Organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/last-activated

GET /api/v1/organization/device/last-activated HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 101,
    "orgId": 9,
    "templateId": 201,
    "ownerUserId": 202,
    "activationTime": 1707244800000
  }
]

Get device metadata fields

get

Retrieve all metadata field values for a device

Required permissions, when user-scoped authentication is used: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can read metafields only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

deviceIdinteger · int32Required

Device ID

Responses

200

Metadata field values

application/json

idinteger · int32Optional

MetaField ID

namestringOptional

MetaField name

isMandatorybooleanOptional

Mark whether the metafield is required

includeInProvisionbooleanOptional

Mark whether the metafield should be included in the provisioning flow

valueone of · nullableOptional

Metafield value. The schema depends on the type discriminator property.

403

Forbidden

404

Device not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/device/metafield

GET /api/v1/organization/device/metafield?deviceId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "name": "text",
    "isMandatory": true,
    "includeInProvision": true,
    "value": {
      "type": "MultiText",
      "values": [
        "SN-001",
        "SN-002"
      ]
    }
  }
]

Update device metadata field

post

Update the value of a specific metadata field for a device.

The new value is validated against the metafield type. Returns 400 if the value is invalid for the metafield type.

Required permissions, when user-scoped authentication is used: ORG_DEVICES_EDIT. Required device view permission: OWN_DEVICES_VIEW or ORG_DEVICES_VIEW. User-scoped tokens can update metafields only for owned devices unless ORG_DEVICES_VIEW is granted.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

deviceIdinteger · int32Required

Device ID

Example: 101

metaFieldIdinteger · int32Required

MetaField ID

Example: 3

newValuestring · max: 200Required

New metafield value

Example: Warehouse Aisle 3

Responses

204

Metadata field updated successfully

400

Bad request

application/json

403

Forbidden

404

Device/metafield not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/device/metafield

POST /api/v1/organization/device/metafield HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "deviceId": 101,
  "metaFieldId": 3,
  "newValue": "Warehouse Aisle 3"
}

No content

PreviousOrganizations NextDataStreams

Last updated 1 day ago

Was this helpful?

hashtagGet devices in organization

hashtagSearch devices

hashtagGet device by ID

hashtagUpdate device

hashtagDelete device

hashtagGet device base info

hashtagCreate a new device

hashtagGet device online status

hashtagGet device tags

hashtagGet device timeline

hashtagGet device logs

hashtagTransfer device to a new owner

hashtagTransfer device to a new organization

hashtagRemove device owner

hashtagClear device data

hashtagTrigger device event

hashtagGet devices by owner

hashtagGet devices by user and organization

hashtagGet last activated devices

hashtagGet device metadata fields

hashtagUpdate device metadata field

Get devices in organization

Search devices

Get device by ID

Update device

Delete device

Get device base info

Create a new device

Get device online status

Get device tags

Get device timeline

Get device logs

Transfer device to a new owner

Transfer device to a new organization

Remove device owner

Clear device data

Trigger device event

Get devices by owner

Get devices by user and organization

Get last activated devices

Get device metadata fields

Update device metadata field