Polaris API reference

Sign in

Exchanges an email and password for a token pair.

Auth None.

Request body

Example request

curl -X POST https://oapi.mersive.com/ \
  -H "Content-Type: application/json" \
  -d '{"email":"integration@example.com","password":"********"}'

Response

{
  "idToken": "eyJhbGciOiJSUzI1NiIs...",
  "refreshToken": "AMf-vBx...",
  "expiresIn": "3600"
}

Errors

Refresh a token

Exchanges a refresh token for a fresh token pair. The refresh token rotates, so persist the one in the response.

Auth None.

Request body

Example request

curl -X POST https://oapi.mersive.com/refresh \
  -H "Content-Type: application/json" \
  -d '{"refreshToken":"AMf-vBx..."}'

Response

{
  "idToken": "eyJhbGciOiJSUzI1NiIs...",
  "refreshToken": "AMf-vBy...",
  "expiresIn": "3600"
}

Errors

List organizations

Returns the organizations the signed-in user belongs to.

Auth Bearer token.

Example request

curl https://oapi.mersive.com/orgs \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "organizations": [
    { "id": "org_8f2c", "name": "Example Corp" }
  ]
}

Errors

List devices

Returns every device in an organization, as ID and name only. Use the status and info calls below for anything more.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/devices/$ORG \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "devices": [
    { "id": "dev_3a91", "name": "Boardroom 4" },
    { "id": "dev_3a92", "name": "Huddle 2B" }
  ]
}

Errors

Display information

What the room display is showing right now: its name, screen key, custom instructions, and state.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/displayinfo/$ORG/$DEVICE \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "externalDeviceId": "MP4A1B2C3D",
  "internalDeviceId": "dev_3a91",
  "displayName": "Boardroom 4",
  "customInstructions": { "enabled": true, "instructions": "Dial 4321 for AV help" },
  "spaceId": "spc_77e1",
  "screenKey": "482913",
  "status": "online",
  "time": "9/30/2026, 2:14:05 PM"
}

externalDeviceId is the serial number. spaceId is the room record the digital signage calls use. status is one of online, offline, in-use, sharing, rebooting, sleep.

Errors

Device network information

Serial number and the network configuration and addresses of each interface.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/deviceinfo/$ORG/$DEVICE \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "deviceDetails": {
    "serialNumber": "MP4A1B2C3D",
    "stunServerEnabled": true,
    "connectionType": {
      "ethernet": {
        "dns1": "10.0.0.2", "dns2": null, "gateway": "10.0.0.1",
        "hostname": "MP4A1B2C3D", "ipType": "IPv4",
        "ipAddress": "10.0.1.88", "macAddress": "00:1A:2B:3C:4D:5E"
      },
      "wifi": { "...": "present only when Wi-Fi is enabled on the device" }
    }
  }
}

Errors

Status of every device

One call for the whole organization: state, network addresses, temperature, and motion-sensor status per device. Not paginated. For large fleets, prefer the paginated fleet reads below.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/device-status-aggregate/$ORG \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "deviceStatuses": {
    "dev_3a91": {
      "deviceId": "dev_3a91",
      "connectionType": ["wired"],
      "ethernetIp": "10.0.1.88", "wifiIp": null,
      "ethernetMac": "00:1A:2B:3C:4D:5E", "wifiMac": null,
      "networkStatus": "connected",
      "state": "online",
      "temperature": "41.2",
      "motionSensorStatus": "active",
      "motionSensorTimestamp": 1759241645000
    }
  }
}

Fields are present only when the device has reported them. A device with no motion sensor has no temperature or motionSensor* keys.

Errors

Reboot a device

Asks a Pod to reboot. Smart TV devices do not support this.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X POST https://oapi.mersive.com/update_device \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"org_id":"'$ORG'","device_id":"'$DEVICE'","action":"reboot","value":true}'

Response

{ "message": "Operation Successful" }

Errors

Sleep or wake a device

Sets the device’s sleep state and the method it uses to turn the display off and on.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

The method is saved to the device’s power-management settings and stays in effect for scheduled sleep as well. Other power-management settings on the device are left as they are.

Example request

curl -X POST https://oapi.mersive.com/sleep \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'","sleep":true,"method":"HDMI_CEC"}'

Response

{ "message": "Operation Successful" }

Errors

Send a command to the display

Queues one raw command string for the Pod to send to the display it controls. Use it for displays that take a control protocol over the Pod’s API power method.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X POST https://oapi.mersive.com/apiCommand \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'","command":"PWR ON"}'

Response

{ "message": "Operation Successful" }

Errors

Get the signage URL

Returns the first signage URL configured for a space.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X POST https://oapi.mersive.com/getDigitalSignageUrl \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"'$ORG'","spaceId":"spc_77e1","userId":"api"}'

Response

{ "url": "https://signage.example.com/lobby" }

Errors

Set the signage URL

Replaces the space’s signage list with one URL and turns signage on or off.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X POST https://oapi.mersive.com/updateDigitalSignageUrl \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tenantId":"'$ORG'","spaceId":"spc_77e1","digitalSignageEnabled":true,"url":"https://signage.example.com/lobby","userId":"api"}'

Response

{ "message": "Digital signage URL updated successfully" }

Errors

List upcoming events

Returns the next three events that have not ended, soonest first.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Query parameters

Example request

curl "https://oapi.mersive.com/calendaring/events?orgId=$ORG&deviceId=$DEVICE" \
  -H "Authorization: Bearer $TOKEN"

Response

[
  {
    "id": "evt-1042",
    "timeStart": "2026-10-01T15:00:00.000Z",
    "timeEnd": "2026-10-01T15:30:00.000Z",
    "status": "upcoming",
    "subject": "Weekly sync",
    "organizerName": "A. Patel",
    "teamsMeetingLink": null
  }
]

status is upcoming, start-soon, or ongoing. Ended events are dropped.

Errors

Create an event

Adds one event to the device’s calendar.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X POST https://oapi.mersive.com/calendaring/event \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'","event":{"id":"evt-1042","subject":"Weekly sync","organizerName":"A. Patel","startTime":"2026-10-01T15:00:00Z","endTime":"2026-10-01T15:30:00Z"}}'

Response

{ "message": "Event set successfully", "id": "evt-1042" }

Errors

Get one event

Returns a single event by the ID you gave it.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Example request

curl "https://oapi.mersive.com/calendaring/event/evt-1042?orgId=$ORG&deviceId=$DEVICE" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "id": "evt-1042",
  "timeStart": "2026-10-01T15:00:00.000Z",
  "timeEnd": "2026-10-01T15:30:00.000Z",
  "status": "upcoming",
  "subject": "Weekly sync",
  "organizerName": "A. Patel",
  "teamsMeetingLink": null
}

Errors

Update an event

Changes any of the event’s fields. Send only what changes; at least one field is required.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Request body

Example request

curl -X PATCH https://oapi.mersive.com/calendaring/event/evt-1042 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'","event":{"endTime":"2026-10-01T16:00:00Z"}}'

Response

{ "message": "Event updated successfully", "reboot_required": true, "restart_required": true }

reboot_required and restart_required are always true and can be ignored; the display picks up the change on its own.

Errors

Delete an event

Removes one event.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Request body

Example request

curl -X DELETE https://oapi.mersive.com/calendaring/event/evt-1042 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'"}'

Response

{ "message": "Event deleted successfully", "reboot_required": true, "restart_required": true }

Errors

Delete several events

Removes a list of events in one call.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Request body

Example request

curl -X DELETE https://oapi.mersive.com/calendaring/events \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"orgId":"'$ORG'","deviceId":"'$DEVICE'","eventsIds":["evt-1042","evt-1043"]}'

Response

{ "message": "Events deleted successfully", "reboot_required": true, "restart_required": true }

Errors

Motion sensor status

Returns one record per motion sensor attached to the device. An empty array means no sensor.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/motionsensor/status/$ORG/$DEVICE \
  -H "Authorization: Bearer $TOKEN"

Response

[
  {
    "name": "Motion sensor",
    "type": ["motion_sensor"],
    "status": "active",
    "tooltipInfo": "",
    "timestamp": 1759241645000,
    "eventType": "MotionDetected",
    "description": "",
    "messageId": "m-9f1",
    "temp": "41.2",
    "cur_state": "pr01",
    "count_pr": 12, "count_pr00": 5, "count_pr01": 7,
    "last_update": 1759241645, "current_time": 1759241650
  }
]

status is active (motion recently detected) or inactive. timestamp is Unix milliseconds. The count_*, cur_state, and last_update fields are raw sensor counters.

Errors

Device status, paginated

State, firmware version, and network addresses for every device.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Example request

curl "https://oapi.mersive.com/device-status/$ORG?limit=500" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "devices": {
    "dev_3a91": {
      "state": "online",
      "firmwareVersion": "18.1.0",
      "connectionType": ["wired"],
      "networkStatus": "connected",
      "ethernetIp": "10.0.1.88", "wifiIp": null,
      "ethernetMac": "00:1A:2B:3C:4D:5E", "wifiMac": null
    },
    "dev_3a92": null
  },
  "nextCursor": "organizations/org_8f2c/devices/dev_3a92"
}

A null record is a device that has never reported status.

Errors

Device info, many at once

The device-information read for many devices in one call. Send deviceIds for a specific set, or send no body to page through every device. POST because the gateway does not allow a body on GET.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Request body

Example request

curl -X POST "https://oapi.mersive.com/deviceinfo/$ORG" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"deviceIds":["dev_3a91","dev_0000"]}'

Response

{
  "devices": [
    {
      "id": "dev_3a91", "name": "Boardroom 4", "orgId": "org_8f2c",
      "status": "online", "lastSeen": "2026-09-30T20:14:05.000Z",
      "ipAddress": "10.0.1.88", "firmwareVersion": "18.1.0",
      "model": "Polaris Pro", "serialNumber": "MP4A1B2C3D",
      "properties": {
        "stunServerEnabled": true,
        "connectionType": { "ethernet": { "...": "as in the single-device read" } }
      }
    }
  ],
  "notFound": ["dev_0000"],
  "nextCursor": null
}

Errors

Calendar events, paginated

Events across every device, optionally limited to a time window.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Example request

curl "https://oapi.mersive.com/calendaring/$ORG?timeStart=2026-10-01T00:00:00-06:00&timeEnd=2026-10-02T00:00:00-06:00" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "events": [
    {
      "id": "evt-1042", "deviceId": "dev_3a91",
      "timeStart": "2026-10-01T15:00:00.000Z", "timeEnd": "2026-10-01T15:30:00.000Z",
      "status": "upcoming", "subject": "Weekly sync",
      "organizerName": "A. Patel", "teamsMeetingLink": null
    }
  ],
  "nextCursor": null
}

Unlike the single-device list, this includes ended events inside the window.

Errors

Current meetings, paginated

For each device: the meeting happening now, the one before it, and the one after.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Example request

curl "https://oapi.mersive.com/calendaring/current-meetings/$ORG" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "devices": {
    "dev_3a91": {
      "current": {
        "id": "evt-1042",
        "timeStart": "2026-10-01T15:00:00.000Z",
        "timeEnd": "2026-10-01T15:30:00.000Z",
        "status": "ongoing",
        "subject": "Weekly sync",
        "organizerName": "A. Patel",
        "teamsMeetingLink": null
      },
      "previous": null,
      "next": null
    }
  },
  "nextCursor": null
}

Errors

Motion sensor status, paginated

The motion-sensor record for every device, or null where there is no sensor.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Query parameters

Example request

curl "https://oapi.mersive.com/motionsensor/status/$ORG" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "devices": {
    "dev_3a91": { "name": "Motion sensor", "type": ["motion_sensor"], "status": "active", "timestamp": 1759241645000, "temp": "41.2", "...": "same record as the single-device read" },
    "dev_3a92": null
  },
  "nextCursor": null
}

Errors

Sleep or wake every device

Starts a job that puts every device in the organization to sleep, or wakes them all.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Request body

Example request

curl -X POST https://oapi.mersive.com/devices/sleep/$ORG \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sleep":true}'

Response

HTTP/1.1 202 Accepted

{ "jobId": "5b8e2d1c-7f3a-4c9e-9d2b-1a6f0e4c8b7d" }

Errors

Sleep job status

Progress of a sleep or wake job.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/devices/sleep/$ORG/$JOB \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "jobId": "5b8e2d1c-7f3a-4c9e-9d2b-1a6f0e4c8b7d",
  "status": "partial_failure",
  "total": 120,
  "succeeded": 118,
  "failed": 2,
  "failedDeviceIds": ["dev_3a92", "dev_3b10"]
}

status is pending, processing, completed, partial_failure, or failed.

Errors

Set signage on every room

Starts a job that sets one signage URL, on or off, for every space in the organization.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Request body

Example request

curl -X POST https://oapi.mersive.com/digital-signage/$ORG \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://signage.example.com/lobby","enabled":true}'

Response

HTTP/1.1 202 Accepted

{ "jobId": "c2f4a9e1-3d7b-4e8a-b5c6-9f0d1e2a3b4c" }

Errors

Signage job status

Progress of a signage job. Failures are reported by space, not device.

Auth Bearer token. The token’s user must be a member of the organization named in the request.

Path parameters

Example request

curl https://oapi.mersive.com/digital-signage/$ORG/$JOB \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "jobId": "c2f4a9e1-3d7b-4e8a-b5c6-9f0d1e2a3b4c",
  "status": "completed",
  "total": 120,
  "succeeded": 120,
  "failed": 0,
  "failedSpaceIds": []
}

Errors