Référence · Playlists

Lister les playlists

GET /v1/playlists

Liste les playlists des organisations dans lesquelles l'utilisateur peut voir les playlists, par ordre alphabétique.

Réponse paginée : les éléments se trouvent dans data et les informations de la page dans meta. Pagination et filtres

Paramètres

Nom	Type	Description
`organization`	`string`	uid d'une organisation, pour ne renvoyer que ses éléments (voir `/organizations`).
`q`	`string`	Partie du nom, 100 caractères maximum.
`page`	`integer`	Page, à partir de 1. Par défaut : 1.
`per_page`	`integer`	Éléments par page, de 1 à 100. Par défaut : 50.

Champs de chaque élément

uid string: Identifiant de la playlist.
name string: Nom de la playlist.
organization object: Organisation de la playlist : uid et name.
total_time integer: Durée totale de la playlist, en secondes.
total_time_is_approximate boolean: true si la durée totale est une estimation.

Erreurs possibles

400 invalid_parameter Un paramètre a une valeur invalide, par exemple per_page au-delà du maximum.
404 organization_not_found Le paramètre organization indiqué ne correspond à aucune organisation dans laquelle l'utilisateur peut voir ce type d'élément.
Les erreurs de clé et de limite s'appliquent à tous les endpoints. Voir toutes les erreurs

RequêtecURLPHPJavaScript

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();

Réponse200

{
  "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
  }
}