DOCUMENTATION

Get User Playlists List

Web App API

This returns a list of playlists in the organizations that the authenticated user is a part of. Optionally, a specific organization ID can be provided to only return the list of playlists for that organization.

API URL (GET)

https://app.retrieverdigitalsignage.com/api/user/get-playlists

Authorization Header

Bearer TOKEN_HERE

(Example: Bearer 1|Tazc1INPh1ftqDWpI9bJUbugyuVzkvwNZaipp4yK367322f6)

Other Headers

Accept: application/json

URL Parameters (Optional)

Use this optional parameter to only return the list of playlists for a specific organization ID.

?organization_id=e8e3f3a0-03d3-11ef-bd14-ef27eae01ca4

Example Call Using CURL

curl -X GET \
  'https://app.retrieverdigitalsignage.com/api/user/get-playlists?organization_id=e8e3f3a0-03d3-11ef-bd14-ef27eae01ca4' \
  -H 'Authorization: Bearer 1|Tazc1INPh1ftqDWpI9bJUbugyuVzkvwNZaipp4yK367322f6' \
  -H 'Accept: application/json' \

Example Response

{
    "status": "success",
    "playlists": [
        {
            "id": "ba2523e0-be48-11ef-b32f-29af289ba0a6",
            "name": "Playlist 1",
            "organization_id": "e8e3f2a0-03d3-11ef-bd14-ef27ebe01ca4",
            "organization_name": "Organization 1",
            "slide_count": 7,
            "device_count": 3
        },
        {
            "id": "78ded320-1deb-11eb-b63b-320d21443d62",
            "name": "Playlist 2",
            "organization_id": "e8e3f2a0-03d3-11ef-bd14-ef27ebe01ca4",
            "organization_name": "Organization 1",
            "slide_count": 11,
            "device_count": 1
        },
        {
            "id": "1b96da01-db99-11ec-b91a-1baea3143cef",
            "name": "Playlist 3",
            "organization_id": "e8e3f2a0-03d3-11ef-bd14-ef27ebe01ca4",
            "organization_name": "Organization 1",
            "slide_count": 3,
            "device_count": 4
        },
    ]
}