Referencia · Listas de reproducción

Listar listas

GET /v1/playlists

Devuelve las listas de reproducción de las organizaciones en las que el usuario puede ver listas, en orden alfabético.

Respuesta paginada: los elementos vienen en data y la información de la página, en meta. Paginación y filtros

Parámetros

Nombre	Tipo	Descripción
`organization`	`string`	uid de una organización, para obtener solo sus elementos (consulte `/organizations`).
`q`	`string`	Parte del nombre, hasta 100 caracteres.
`page`	`integer`	Página, a partir de 1. Por defecto: 1.
`per_page`	`integer`	Elementos por página, de 1 a 100. Por defecto: 50.

Campos de cada elemento

uid string: Identificador de la lista de reproducción.
name string: Nombre de la lista.
organization object: Organización de la lista: uid y name.
total_time integer: Duración total de la lista, en segundos.
total_time_is_approximate boolean: true si la duración total es una estimación.

Posibles errores

400 invalid_parameter Un parámetro tiene un valor no válido, como per_page por encima del máximo.
404 organization_not_found El organization indicado no corresponde a una organización en la que el usuario pueda ver este tipo de elemento.
Los errores de clave y de límite se aplican a todos los endpoints. Ver todos los errores

PeticióncURLPHPJavaScript

curl "https://api.on-cloud.live/v1/playlists?per_page=2" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/playlists?per_page=2');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/playlists?per_page=2', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data, meta } = await res.json();

Respuesta200

{
  "data": [
    {
      "uid": "1f0e3dad99908345f7439f8ffabdffc4",
      "name": "Lista do caixa",
      "organization": {
        "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
        "name": "Loja Shopping Norte"
      },
      "total_time": 40,
      "total_time_is_approximate": false
    },
    {
      "uid": "e4da3b7fbbce2345d7772b0674a318d5",
      "name": "Lista principal",
      "organization": {
        "uid": "8f14e45fceea167a5a36dedd4bea2543",
        "name": "Loja Centro"
      },
      "total_time": 85,
      "total_time_is_approximate": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 2,
    "total": 2,
    "total_pages": 1
  }
}