リファレンス · プレイリスト

プレイリスト一覧を取得

GET /v1/playlists

ユーザーがプレイリストを閲覧できる組織のプレイリストを、名前順で一覧表示します。

ページ分割されたレスポンスです。項目はdataに、ページ情報はmetaに入ります。ページネーションとフィルター

パラメーター

名前	型	説明
`organization`	`string`	組織のuid。その組織の項目のみを返します（`/organizations`を参照）。
`q`	`string`	名前の一部（最大100文字）。
`page`	`integer`	ページ番号（1から）。デフォルト：1。
`per_page`	`integer`	1ページあたりの項目数（1～100）。デフォルト：50。

各項目のフィールド

uid string: プレイリストの識別子。
name string: プレイリスト名。
organization object: プレイリストが属する組織：uidとname。
total_time integer: プレイリストの合計時間（秒）。
total_time_is_approximate boolean: 合計時間が概算の場合はtrue。

発生しうるエラー

400 invalid_parameter パラメーターの値が無効です（例：per_pageが上限を超えている）。
404 organization_not_found 指定されたorganizationは、ユーザーがこの種類の項目を参照できる組織ではありません。
キーとレート制限に関するエラーは、すべてのエンドポイントに共通です。すべてのエラーを見る

リクエストcURLPHPJavaScript

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

レスポンス200

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