Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yodeck Screens API

Screens (monitors/players), their status, and remote control.

Yodeck Screens API is one of 7 APIs that Yodeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Screens. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://app.yodeck.com/api/v1.

6 operations 3 paths 3 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://app.yodeck.com/api/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Yodeck Screens API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Named, role-scoped API token generated in the Yodeck console (Account Settings Advanced Settings API Tokens). The token acts as a user with the permissions of…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Screens 6

Screens (monitors/players), their status, and remote control.

GET
/monitors/
List screens (monitors)
listScreens → 200
POST
/monitors/
Register a screen
createScreen body → 201
GET
/monitors/{id}/
Retrieve a screen
getScreen 1 param → 200
PATCH
/monitors/{id}/
Update a screen
updateScreen 1 param body → 200
DELETE
/monitors/{id}/
Delete a screen
deleteScreen 1 param → 204
POST
/monitors/{id}/reboot/
Reboot a screen (modeled action)
rebootScreen 1 param → 202

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Screen (7 properties), ScreenInput (3 properties), ScreenList (2 properties). Each schema is shown below with its type and property counts.

ScreenInput
object
3 properties
Screen
object
7 properties
ScreenList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yodeck-signage-screens-api-openapi.yml Raw ↑

Other APIs Yodeck publishes across the network.

Yodeck Layouts API
Yodeck Media API
Yodeck Playlists API
Yodeck Schedules API
Yodeck Shows API
Yodeck Workspaces API