# List channel playlists

Stream playlists from a channel's playlists tab.

- Platform: [YouTube](https://docs.upscrape.com/docs/platforms/youtube)
- Capability ID: `youtube.channel-playlists.list`
- Cost: 1 credit per request
- Maximum runtime: 120 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "limit": 2,
    "max_pages": 1,
    "url": "@NASA"
  },
  "capability": "youtube.channel-playlists.list"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | Maximum number of results to return. From 1 to 500. Default: `100`. |
| `max_pages` | `integer` | No | Maximum number of result pages to fetch. From 1 to 100. Default: `5`. |
| `url` | `string` | Yes | Public URL of the page to fetch. |

### Example input

```json
{
  "limit": 2,
  "max_pages": 1,
  "url": "@NASA"
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

### Illustrative sample output

This example shows one response. Values and optional fields vary with the data available.

```json
{
  "items": [
    {
      "playlist_id": "PLF98rxtslw6s",
      "thumbnails": [
        {
          "height": 270,
          "url": "https://i.ytimg.com/vi/9wq3VHsL_bE/hqdefault.jpg?sqp=-oaymwEXCOADEI4CSFryq4qpAwkIARUAAIhCGAE=&rs=AOn4CLCC7609JJdE1ic8h5PLtaCFmDRDYg",
          "width": 480
        }
      ],
      "title": "Nancy Grace Roman Space Telescope",
      "type": "playlist",
      "video_count": "3 videos"
    },
    {
      "playlist_id": "PLB29CbKaE2OY",
      "thumbnails": [
        {
          "height": 240,
          "url": "https://i.ytimg.com/pl_c/PLB29CbKaE2OY/studio_square_thumbnail.jpg?sqp=[redacted:token]=&rs=AOn4CLCXIxbJHzYlFenEnofyVNgsjAIJkw",
          "width": 426
        },
        {
          "height": 480,
          "url": "https://i.ytimg.com/pl_c/PLB29CbKaE2OY/studio_square_thumbnail.jpg?sqp=[redacted:token]=&rs=AOn4CLDzfMrarbq4twUchJcaNcVszY9swQ",
          "width": 854
        },
        {
          "height": 720,
          "url": "https://i.ytimg.com/pl_c/PLB29CbKaE2OY/studio_square_thumbnail.jpg?sqp=[redacted:token]=&rs=AOn4CLDnCuJVqWChwenUh1uKaYKxyx9f0A",
          "width": 1280
        }
      ],
      "title": "NASA Moon Base",
      "type": "playlist",
      "video_count": "9 videos"
    }
  ],
  "summary": {
    "channel_id": "UCLA_DiR1FfKNvjuUpBHmylQ",
    "has_more": true,
    "pages": 1,
    "tab": "playlists",
    "total_items": 2
  }
}
```
### Illustrative output fields

Derived from the sample above for orientation only. These fields are not a fixed response schema.

| Path | Observed type | Example |
| --- | --- | --- |
| `items` | `array` | 2 items |
| `items` | `array` | 2 items |
| `summary` | `object` | 5 fields |
| `summary.channel_id` | `string` | UCLA_DiR1FfKNvjuUpBHmylQ |
| `summary.has_more` | `boolean` | true |
| `summary.pages` | `integer` | 1 |
| `summary.tab` | `string` | playlists |
| `summary.total_items` | `integer` | 2 |

## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)