---
title: "Search Playlists"
method: GET
path: "/playlist"
tags: ["playlist"]
---

# Search Playlists

`GET /playlist`

Search for Playlists viewable by this user

## Query parameters

- `playlistId` integer
- `name` string
- `userId` integer
- `tags` string
- `exactTags` integer
- `logicalOperator` string
- `ownerUserGroupId` integer
- `embed` string
- `folderId` integer
- `modifiedDateFrom` string
- `modifiedDateTo` string
- `sortBy` 'playlistId' | 'name' | 'duration' | 'owner' | 'isDynamic' | 'enableStat' | 'createdDt' | 'modifiedDt' | 'groupsWithPermissions'
- `sortDir` 'asc' | 'desc'

## Response `200`

successful operation

- Playlist[]
  - `playlistId` integer — The ID of this Playlist
  - `ownerId` integer — The userId of the User that owns this Playlist
  - `name` string — The Name of the Playlist
  - `regionId` integer — The RegionId if this Playlist is specific to a Region
  - `isDynamic` integer — Flag indicating if this is a dynamic Playlist
  - `filterMediaName` string — Filter Name for a Dynamic Playlist
  - `filterMediaNameLogicalOperator` string — Which logical operator should be used when filtering by multiple Plalust names? OR|AND
  - `filterMediaTags` string — Filter Tags for a Dynamic Playlist
  - `filterExactTags` integer — Flag indicating whether to filter by exact Tag match
  - `filterMediaTagsLogicalOperator` string — Which logical operator should be used when filtering by multiple Tags? OR|AND
  - `filterFolderId` integer — The ID of the folder to filter media items by
  - `maxNumberOfItems` integer — Maximum number of Media items matching dynamic Playlist filters
  - `createdDt` string — The datetime this entity was created
  - `modifiedDt` string — The datetime this entity was last modified
  - `duration` integer — A read-only estimate of this Layout's total duration in seconds. This is equal to the longest region duration and is valid when the layout status is 1 or 2.
  - `requiresDurationUpdate` integer — Flag indicating whether this Playlists requires a duration update
  - `enableStat` string — The option to enable the collection of Playlist Proof of Play statistics
  - `tags` TagLink[] — Tags associated with this Playlist, array of TagLink objects
    - `tag` string — The Tag
    - `tagId` integer — The Tag ID
    - `value` string — The Tag Value
  - `widgets` Widget[] — An array of Widgets assigned to this Playlist
    - `widgetId` integer — The Widget ID
    - `playlistId` integer — The ID of the Playlist this Widget belongs to
    - `ownerId` integer — The ID of the User that owns this Widget
    - `type` string — The Module Type Code
    - `duration` integer — The duration in seconds this widget should be shown
    - `displayOrder` integer — The display order of this widget
    - `useDuration` integer — Flag indicating if this widget has a duration that should be used
    - `calculatedDuration` integer — Calculated Duration of this widget after taking into account the useDuration flag
    - `createdDt` string — The datetime the Layout was created
    - `modifiedDt` string — The datetime the Layout was last modified
    - `fromDt` integer — Widget From Date
    - `toDt` integer — Widget To Date
    - `schemaVersion` integer — Widget Schema Version
    - `transitionIn` integer — Transition Type In
    - `transitionOut` integer — Transition Type out
    - `transitionDurationIn` integer — Transition duration in
    - `transitionDurationOut` integer — Transition duration out
    - `widgetOptions` WidgetOption[] — An array of Widget Options
      - `widgetId` integer — The Widget ID that this Option belongs to
      - `type` string — The option type, either attrib or raw
      - `option` string — The option name
      - `value` string — The option value
    - `mediaIds` integer[] — An array of MediaIds this widget is linked to
    - `audio` WidgetAudio[] — An array of Audio MediaIds this widget is linked to
      - `widgetId` integer — The Widget Id
      - `mediaId` integer — The Media Id
      - `volume` integer — The percentage volume
      - `loop` integer — Flag indicating whether to loop
    - `permissions` Permission[] — An array of permissions for this widget
      - `permissionId` integer — The ID of this Permission Record
      - `entityId` integer — The Entity ID that this Permission refers to
      - `groupId` integer — The User Group ID that this permission refers to
      - `objectId` integer — The object ID that this permission refers to
      - `isUser` integer — A flag indicating whether the groupId refers to a user specific group
      - `entity` string — The entity name that this refers to
      - `objectIdString` string — Legacy for when the Object ID is a string
      - `group` string — The group name that this refers to
      - `view` integer — A flag indicating whether view permission is granted
      - `edit` integer — A flag indicating whether edit permission is granted
      - `delete` integer — A flag indicating whether delete permission is granted
      - `modifyPermissions` integer — A flag indicating whether modify permission permission is granted.
    - `playlist` string — The name of the Playlist this Widget is on
  - `permissions` Permission[] — An array of permissions
    - `permissionId` integer — The ID of this Permission Record
    - `entityId` integer — The Entity ID that this Permission refers to
    - `groupId` integer — The User Group ID that this permission refers to
    - `objectId` integer — The object ID that this permission refers to
    - `isUser` integer — A flag indicating whether the groupId refers to a user specific group
    - `entity` string — The entity name that this refers to
    - `objectIdString` string — Legacy for when the Object ID is a string
    - `group` string — The group name that this refers to
    - `view` integer — A flag indicating whether view permission is granted
    - `edit` integer — A flag indicating whether edit permission is granted
    - `delete` integer — A flag indicating whether delete permission is granted
    - `modifyPermissions` integer — A flag indicating whether modify permission permission is granted.
  - `folderId` integer — The id of the Folder this Playlist belongs to
  - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Playlist

---

[API](https://skmtc.net/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.net/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/9136e3c2cb1d/schema)