Skip to main content

Prerequisites

Create a Platform / Workspace key with read permissions using the key guide. Substitute your actual workspace ID; example IDs are placeholders.

Your first request in Postman

  1. Choose GET and enter https://api.layarva.com/api/platform/v1/workspaces/YOUR_WORKSPACE_ID/playlists?ready=true&limit=25.
  2. In Authorization, choose Bearer Token and use your Platform API key. Keep it in a private Postman environment or vault.
  3. Select Send. A successful response contains data and page.
GET does not need Idempotency-Key. For POST, PATCH or DELETE, follow the operation ID examples.

cURL alternative

Backend request helper

This Node.js example obtains configuration from environment variables; no real credential is included. Start with a test workspace. GET requests omit body/Idempotency-Key; all writes use a caller-persisted operation key.
Set LAYARVA_API_HOST=api.layarva.com. Supply LAYARVA_WORKSPACE_ID and LAYARVA_PLATFORM_KEY only on your backend. The public service information is at /, this guide at /docs, and the machine-readable schema at /openapi.json; these three read-only documents require no key and expose no customer data. Every management endpoint still requires its workspace key.

List resources

Successful collection reads are {data:[...],page:{limit,nextCursor}}. Order is ascending opaque ID, not newest-first. limit defaults to 50, max 100. Send returned nextCursor as after; stop when null. This is keyset pagination, not a transactionally frozen snapshot of all pages. Detail reads are {data:{...}} and reject query parameters. IDs are restricted to 1–100 ASCII letters/digits/underscore/hyphen. Additional collections: /groups (library.read: q,id,libraryType), /publications (publications.read: id,channelId,playlistId), /approval-requests (publications.request: pagination only). Playlist /playlists/{id}/versions, Screen /screens/{id}/offline-leases and /screens/{id}/offline-exports accept pagination only. q is case-insensitive name-substring search, not arbitrary SQL/full-text expressions. Filter values are case-sensitive where enums are specified. Repeated or unknown parameters are rejected, not silently ignored. ready=true means a server-owned immutable Ready version exists; it does not mean unsaved/current draft edits are published. Schedule controlState filter accepts DRAFT|ENABLED|PAUSED: ENABLED is a normalized query alias matching stored ACTIVE as well as ENABLED. Returned controlState remains the actual stored state and may therefore be ACTIVE; do not infer that response values are identical to query enums.