REreveldigital
Devices

Gets all devices in an account.

Changed on
get/devices

Request

  • Base URL
    https://api.reveldigital.com
  • Auth
    • OAuth 2
      Authorization codehttps://id.reveldigital.com/connect/authorize
      Token URLhttps://id.reveldigital.com/connect/token
      Scopeswebapi
    • or API key in header X-RevelDigital-ApiKey
    • or API key in query parameter api_key
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring

Unique identifier for the device.

takeinteger

Maximum number of items to retrieve in a query.

pageinteger

Current page number for paginated results.

device_type_idstring

Unique identifier for the type of device.

group_idstring[]

List of unique identifiers for media groups to filter by.

group_namestring[]

Collection of group names to filter by.

include_snapboolean

Include the snapshot of the currently playing content. JPG format, base64 encoded.

org_idstring

Unique identifier for an organization to filter by.

is_onlineboolean

Filter devices by their online status.

Response

OK

idstring nullable

The device id

namestring nullable

The device name

group_namestring nullable

The group name

group_idstring nullable

The group id

tagsstring nullable

Tags associated with this device

entered_servicestring date-time nullable

The date the device was registered

last_servicestring date-time nullable

The last service date

timezonestring nullable

The timezone of the device

language_codestring nullable

The language code of the device

last_updatestring date-time nullable

The timestamp of the last content sync with the server

registration_keystring nullable

The device registration key

encrypted_registration_keystring nullable

The encrypted registration key

mac_addressstring nullable

The device MAC address, if applicable

service_levelstring nullable

The device service level

in_syncboolean

Is the device content in sync with server

serial_numberstring nullable

The device serial number

modelstring nullable

The device hardware model

deactivatedboolean nullable

Is the device deactivated

notesstring nullable

The device notes

is_onlineboolean

Is the device currently online. A device is considered online if it has a timestamp within the last 5 minutes

screen_orientationinteger nullable

Degrees of screen rotation. One of 0, 90, 180 or 270. A null value means the orientation is not stated.

is_audio_enabledboolean nullable

Whether the screen can play audible audio. A null value means this is not stated, and is never treated as false.

is_outdoorboolean nullable

Whether the screen is deployed outdoors. A null value means this is not stated, and is never treated as false.

Changes

  • 39d5c8302822Revision changes
    • info

      added the optional property / to the response with the status

  • 0c4ba3fb6d1aRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status