---
title: "getPlaylists"
method: GET
path: "/households/{householdId}/playlists"
tags: ["playlists"]
---

# getPlaylists

`GET /households/{householdId}/playlists`

## Request

- Base URL: `https://api.ws.sonos.com/control/api/v1`
- URL: `https://api.ws.sonos.com/control/api/v1/households/{householdId}/playlists`
- Auth: OAuth 2 and HTTP bearer and API key in header `X-Sonos-Api-Key`
  - Authorization code: `https://api.sonos.com/login/v3/oauth`
  - Token URL: `https://api.sonos.com/login/v3/oauth/access` scopes: `playback-control-all`

Use the getPlaylists command to get the list of Sonos playlists for a household. Playlists do not include pinned items (any non-playable containers pinned to My Sonos) or Sonos favorites. See the Save your favorites section in the Sonos user guide for details about My Sonos.

 Returns a playlistsList object, which is an array of playlist objects with a version number.

## Response `200`

See the x-muse-error-codes extension for a list of muse errors that generate this response

- PlaylistsList: No description available
  - `version` string, nullable: The new version string. Sonos updates this version whenever the Sonos playlists change for the household. Your app can then send a getPlaylists command to receive the new list of playlists.
  - `playlists` Playlist[], nullable: An array of playlist objects.
    - `id` string, required: An identifier for the playlist.
    - `name` string, required: A user-identifiable name.
    - `type` string, nullable: The type of list. This is “playlist”.
    - `trackCount` integer, nullable: The number of tracks in the playlist.

## Other responses

- `400`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `401`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `403`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `404`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `499`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `500`: See the x-muse-error-codes extension for a list of muse errors that generate this response
- `503`: See the x-muse-error-codes extension for a list of muse errors that generate this response

---

[API](https://skmtc.dev/sonos/apis/sonos-control-api-cloud.md) - [All operations](https://skmtc.dev/sonos/apis/sonos-control-api-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/sonos/apis/sonos-control-api-cloud/revisions/0c452bcf7b2a?raw)