Authentication

Create API key

  • Go to CMS Admin > Account settings > Developers > API tokens to create an API token.
  • Create an API key with a memorable name and choose scopes.
  • Click create, and you will be shown the API key. Copy it to a safe place as this is the last time you can see it.

Making requests with API key

The API key should be used as an Auth Bearer Token:

Authorization: Bearer {token}

Requests should be made to the following URL:

https://api.embedsignage.com

Filtering

Param: filter

Search values with spaces must be wrapped in ""

https://api.embedsignage.com/devices?filter=platform+eq+"Samsung tizen"

Basic filters

eq = Equals
/devices?filter=platform+eq+BrightSign
ne = Not equal
/devices?filter=platform+ne+BrightSign
lt = Less than
/devices?filter=last_connected+lt+2024-06-20T13:27
le = Less than or equal to
/devices?filter=last_connected+le+2024-06-20T13:27
gt = Greater than
/devices?filter=last_connected+gt+2024-06-20T13:27
ge = Greater than or equal to
/devices?filter=last_connected+ge+2024-06-20T13:27
co = Contains
/devices?filter=platform+co+samsung
noco = Does not contain
/devices?filter=platform+noco+windows
in = in values (comma separated string)
/devices?filter=platform+in+windows,brightsign,android
notin = not in values (comma separated string)
/devices?filter=platform+notin+windows,brightsign,android

Advanced filters

Chain filters using and | or
/devices?filter=platform+eq+windows+and+last_connected+gt+2024-06-20T13:27
/devices?filter=platform+eq+windows+or+last_connected+gt+2024-06-20T13:27
Group filters with ()
/devices?filter=(platform+eq+brightsign+or+platform+eq+windows)+and+(model+eq+XC2055+or+model+eq+64bit)

Available properties to filter by and sort

Channels

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /channels?filter=account_id+eq+{accountID}
  • Created at (UTC) timestamp
    • /channels?filter=last_published+le+2024-06-20T12:30
  • Layout ID (only filtering) string
    • only use with eq | ne | in | notin
    /channels?filter=layout+notin+{layoutID},{layoutID},{layoutID}
  • Name string
    • /channels?filter=name+eq+"channel name"
  • Overrides (only filtering) boolean
    • /channels?filter=overrides+eq+false
  • Schedules (only filtering) boolean
    • /channels?filter=schedules+eq+true

Devices

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /devices?filter=account_id+eq+{accountID}
  • App version string
    • /devices?filter=app_version+eq+4.3.1
  • Connection type string
    • /devices?filter=connection_type+in+wifi,unknown,ethernet,cellular
  • Created (UTC) timestamp
    • /devices?filter=created+gt+2024-06-20T12:30
  • Embed Device ID string
    • /devices?filter=id+eq+{deviceID}
  • Last connected (UTC) timestamp
    • /devices?filter=last_connected+gt+2024-06-20T12:30
  • Model string
    • /devices?filter=model+eq+xc4055
  • Name string
    • /devices?filter=name+eq+"device name"
  • Notes string
    • /devices?filter=notes+co+"Test note"
  • Orientation string
    • /devices?filter=orientation+in+landscape,portrait
  • Platform string
    • /devices?filter=platform+eq+brightsign
  • Software version string
    • /devices?filter=software_version+co+9.0.120
  • State string
    • /devices?filter=state+in+live,commissioning,decommissioned,testing

Folders

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /folders?filter=account_id+eq+{accountID}
  • Created (UTC) timestamp
    • /folders?filter=created+le+2024-06-20T12:30
  • Name string
    • /folders?filter=name+in+"folder A","folder B","folder C"
  • Section string
    • /folders?filter=section+eq+devices
  • Updated (UTC) timestamp
    • /folders?filter=updated+ge+2024-06-20T12:30

Layouts

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /layouts?filter=account_id+eq+{accountID}
  • Created (UTC) timestamp
    • /layouts?filter=created+le+2024-06-20T12:30
  • Name string
    • /layouts?filter=name+in+"layout A","layout B","layout C"
  • Updated (UTC) timestamp
    • /layouts?filter=updated+ge+2024-06-20T12:30

Licenses

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /licenses?filter=account_id+eq+{accountID}
  • Created (UTC) timestamp
    • /licenses?filter=created+le+2024-06-20T12:30
  • Updated (UTC) timestamp
    • /licenses?filter=updated+ge+2024-06-20T12:30
  • Valid from (UTC) timestamp
    • /licenses?filter=valid_from+ge+2024-06-20T12:30
  • Valid until (UTC) timestamp
    • /licenses?filter=valid_until+ge+2024-06-20T12:30

Media

  • Account ID (only reseller filtering) string
    • only use with eq | ne | in | notin
    /media?filter=account_id+eq+{accountID}
  • Created (UTC) timestamp
    • /media?filter=created+gt+2024-06-20T12:30
  • Folder ID (only filtering) string
    • only use with eq | ne | in | notin
    /media?filter=folder+notin+{folderID,folderID,folderID}
  • Mime string
    • /media?filter=mime+ne+image/jpeg
  • Name string
    • /media?filter=name+eq+"file name"
  • Type string
    • /media?filter=type+in+audio,video
  • Updated (UTC) timestamp
    • /media?filter=updated+le+2024-06-20T12:30

Pagination

itemsPerPage - Total number of results to return.

startIndex - Number of results to skip.

https://api.embedsignage.com/devices?startIndex=0&itemsPerPage=10

Sorting

Params: sortBy | sortOrder

Values: asc | desc

https://api.embedsignage.com/channels?sortBy=last_published&sortOrder=asc

Reseller endpoints

Reseller endpoints are only available to embed signage resellers, they allow a reseller to access information related to their direct sub accounts. For more information on becoming a reseller, click here.