---
title: "Library Search"
method: GET
path: "/library"
tags: ["library"]
---

# Library Search

`GET /library`

Search the Library for this user

## Query parameters

- `mediaId` integer
- `media` string
- `type` string
- `ownerId` integer
- `retired` integer
- `tags` string
- `exactTags` integer
- `logicalOperator` string
- `duration` string
- `fileSize` string
- `ownerUserGroupId` integer
- `folderId` integer

## Response `200`

successful operation

- Media[]
  - `mediaId` integer — The Media ID
  - `ownerId` integer — The ID of the User that owns this Media
  - `parentId` integer — The Parent ID of this Media if it has been revised
  - `name` string — The Name of this Media
  - `mediaType` string — The module type of this Media
  - `storedAs` string — The file name of the media as stored in the library
  - `fileName` string — The original file name as it was uploaded
  - `tags` TagLink[] — Tags associated with this Media, array of TagLink objects
    - `tag` string — The Tag
    - `tagId` integer — The Tag ID
    - `value` string — The Tag Value
  - `fileSize` integer — The file size in bytes
  - `duration` integer — The duration to use when assigning this media to a Layout widget
  - `valid` integer — Flag indicating whether this media is valid.
  - `moduleSystemFile` integer — DEPRECATED: Flag indicating whether this media is a system file or not
  - `expires` integer — Timestamp indicating when this media should expire
  - `retired` integer — Flag indicating whether this media is retired
  - `isEdited` integer — Flag indicating whether this media has been edited and replaced with a newer file
  - `md5` string — A MD5 checksum of the stored media file
  - `owner` string — The username of the User that owns this media
  - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this Media
  - `released` integer — A flag indicating whether this media has been released
  - `apiRef` string — An API reference
  - `createdDt` string — The datetime the Media was created
  - `modifiedDt` string — The datetime the Media was last modified
  - `enableStat` string — The option to enable the collection of Media Proof of Play statistics
  - `orientation` string — The orientation of the Media file
  - `width` integer — The width of the Media file
  - `height` integer — The height of the Media file
  - `folderId` integer — The id of the Folder this Media belongs to
  - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Media

## Changes

- **2022-02-08** `6d18f62f7782` — 1 info
  - added the new optional `query` request parameter `logicalOperator`
- **2021-02-09** `9ddbdc81e86a` — 1 info
  - added the new optional `query` request parameter `folderId`
- **2020-02-17** `8e1275395104` — 1 breaking, 6 warning
  - removed the media type `application/json` for the response with the status `200`
  - deleted the `query` request parameter `folderId`
  - deleted the `query` request parameter `isReturnPublicUrls`
  - deleted the `query` request parameter `keyword`
  - …3 more

[Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/library/get.md)

---

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