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 Playlists API

Ordered sequences of media with per-item duration and transitions.

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

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

This API exposes 5 operations across 2 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.

5 operations 2 paths 3 schemas 1 DELETE2 GET1 PATCH1 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 Playlists 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 5

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

Playlists 5

Ordered sequences of media with per-item duration and transitions.

GET
/playlists/
List playlists
listPlaylists 2 params → 200
POST
/playlists/
Create a playlist
createPlaylist body → 201
GET
/playlists/{id}/
Retrieve a playlist
getPlaylist 1 param → 200
PATCH
/playlists/{id}/
Update a playlist
updatePlaylist 1 param body → 200
DELETE
/playlists/{id}/
Delete a playlist
deletePlaylist 1 param → 204

Schemas 3

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

PlaylistList
object
2 properties
PlaylistInput
object
2 properties 1 required
Playlist
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Yodeck publishes across the network.

Yodeck Layouts API
Yodeck Media API
Yodeck Schedules API
Yodeck Screens API
Yodeck Shows API
Yodeck Workspaces API