Skip to content

GetPlaylistCount

Walter Lara edited this page May 18, 2024 · 3 revisions

Get Playlist Count

Allows to get a playlist count based on filters.

Request

URLs: /v1/playlists/count

Method: GET

Path Parameters: None

Query Parameters:

Parameter Type Description Requirement Type
ids string list Comma-separated list of playlist UUID's for filtering results. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified. Optional
ownerIds string list Comma-separated list of owner UUID's for filtering results. A value of "me" can be used instead of the caller's UUID. Prefix each value with - to exclude and + (optional) to include. Defaults to inclusion if no prefix is specified. Optional
olderThan string ISO-8601 formated oldest (maximum) timestamp to filter-out results. If missing, defaults to no filtering out. Optional
newerThan string ISO-8601 formated newest (minimum) timestamp to filter-out results. If missing, defaults to no filtering out. Optional

Headers:

Authorization: Bearer {accessToken}

Accept: application/json

✅ Success Response

Code: 200 OK

Headers:

Content-Type: application/json

Content:

Field Type Description Condition
count long Playlist count. Always

Content example:

{
    "count": 300
}

❌ Error Responses

1. Unauthorized

Code: 401 UNAUTHORIZED

Condition: If {accessToken} is invalid or expired.

2. Unprocessable Entity

Code: 422 UNPROCESSABLE ENTITY

Condition: If ownerId is malformed.

Headers:

Content-Type: application/json

Content example:

{
    "code": 422,
    "description": "Unprocessable Entity",
    "cause": "Invalid UUID string: 123456789"
}

See Also

Post Playlist (Add New Playlist)

Patch Playlist (Update Playlist)

Get Playlists

Get Playlist

Delete Playlist

Put Playlist Song

Get Playlist Songs

Delete Playlist Song

Clone this wiki locally