--- title: "Display Search" method: GET path: "/display" tags: ["display"] --- # Display Search `GET /display` Search Displays for this User ## Query parameters - `displayId` integer - `displayGroupId` integer - `display` string - `tags` string - `exactTags` integer - `logicalOperator` string - `macAddress` string - `hardwareKey` string - `clientVersion` string - `clientType` string - `clientCode` string - `embed` string - `authorised` integer - `displayProfileId` integer - `mediaInventoryStatus` integer - `loggedIn` integer - `lastAccessed` string - `folderId` integer - `xmrRegistered` integer - `isPlayerSupported` integer - `sortBy` 'displayId' | 'display' | 'clientType' | 'clientCode' | 'clientVersion' | 'mediaInventoryStatus' | 'clientAddress' | 'licensed' | 'loggedIn' | 'deviceName' | 'address' | 'storageAvailableSpace' | 'storageTotalSpace' | 'description' | 'orientation' | 'resolution' | 'defaultLayout' | 'incSchedule' | 'emailAlert' | 'lastAccessed' | 'macAddress' | 'timeZone' | 'languages' | 'latitude' | 'longitude' | 'screenShotRequested' | 'bandwidthLimit' | 'lastCommandSuccess' | 'commercialLicence' | 'groupsWithPermissions' | 'screenSize' | 'isMobile' | 'isOutdoor' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5' | 'customId' | 'costPerPlay' | 'impressionsPerPlay' | 'createdDt' | 'modifiedDt' | 'countFaults' | 'osVersion' | 'osSdk' | 'manufacturer' | 'brand' | 'model' | 'cmsTransfer' | 'xmrRegistered' - `sortDir` 'asc' | 'desc' ## Response `200` successful operation - Display[] - `displayId` integer — The ID of this Display - `displayTypeId` integer — The Display Type ID of this Display - `venueId` integer — The Venue ID of this Display - `address` string — The Location Address of this Display - `isMobile` integer — Is this Display mobile? - `languages` string — The Languages supported in this display location - `displayType` string — The type of this Display - `screenSize` integer — The screen size of this Display - `isOutdoor` integer — Is this Display Outdoor? - `customId` string — The custom ID (an Id of any external system) of this Display - `costPerPlay` number, double — The Cost Per Play of this Display - `impressionsPerPlay` number, double — The Impressions Per Play of this Display - `ref1` string — Optional Reference 1 - `ref2` string — Optional Reference 2 - `ref3` string — Optional Reference 3 - `ref4` string — Optional Reference 4 - `ref5` string — Optional Reference 5 - `auditingUntil` integer — Flag indicating whether this Display is recording Auditing Information from XMDS - `display` string — The Name of this Display - `description` string — The Description of this Display - `defaultLayoutId` integer — The ID of the Default Layout - `license` string — The Display Unique Identifier also called hardware key - `licensed` integer — A flag indicating whether this Display is licensed or not - `loggedIn` integer — A flag indicating whether this Display is currently logged in - `lastAccessed` integer — A timestamp in CMS time for the last time the Display accessed XMDS - `incSchedule` integer — A flag indicating whether the default layout is interleaved with the Schedule - `emailAlert` integer — A flag indicating whether the Display will send email alerts. - `alertTimeout` integer — A timeout in seconds for the Display to send email alerts. - `clientAddress` string — The MAC Address of the Display - `mediaInventoryStatus` integer — The media inventory status of the Display - `macAddress` string — The current Mac Address of the Player - `lastChanged` integer — A timestamp indicating the last time the Mac Address changed - `numberOfMacAddressChanges` integer — A count of Mac Address changes - `lastWakeOnLanCommandSent` integer — A timestamp indicating the last time a WOL command was sent - `wakeOnLanEnabled` integer — A flag indicating whether Wake On Lan is enabled - `wakeOnLanTime` string — A h:i string indicating the time to send a WOL command - `broadCastAddress` string — The broad cast address for this Display - `secureOn` string — The secureOn WOL settings for this display. - `cidr` string — The CIDR WOL settings for this display - `latitude` number, double — The display Latitude - `longitude` number, double — The display longitude - `clientType` string — A string representing the player type - `clientVersion` string — A string representing the player version - `clientCode` integer — A number representing the Player version code - `displayProfileId` integer — The display settings profile ID for this Display - `currentLayoutId` integer — The current layout ID reported via XMDS - `screenShotRequested` integer — A flag indicating that a screen shot should be taken by the Player - `storageAvailableSpace` integer — The number of bytes of storage available on the device. - `storageTotalSpace` integer — The number of bytes of storage in total on the device - `displayGroupId` integer — The ID of the Display Group for this Device - `currentLayout` string — The current layout - `defaultLayout` string — The default layout - `displayGroups` DisplayGroup[] — The Display Groups this Display belongs to - `displayGroupId` integer — The displayGroup Id - `displayGroup` string — The displayGroup Name - `description` string — The displayGroup Description - `isDisplaySpecific` integer — A flag indicating whether this displayGroup is a single display displayGroup - `isDynamic` integer — A flag indicating whether this displayGroup is dynamic - `dynamicCriteria` string — Criteria for this dynamic group. A comma separated set of regular expressions to apply - `dynamicCriteriaLogicalOperator` string — Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND - `dynamicCriteriaTags` string — Criteria for this dynamic group. A comma separated set of tags to apply - `dynamicCriteriaExactTags` integer — Flag indicating whether to filter by exact Tag match - `dynamicCriteriaTagsLogicalOperator` string — Which logical operator should be used when filtering by multiple Tags? OR|AND - `userId` integer — The UserId who owns this display group - `tags` TagLink[] — Tags associated with this Display Group, array of TagLink objects - `tag` string — The Tag - `tagId` integer — The Tag ID - `value` string — The Tag Value - `bandwidthLimit` integer — The display bandwidth limit - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this DisplayGroup - `createdDt` string — The datetime this entity was created - `modifiedDt` string — The datetime this entity was last modified - `folderId` integer — The id of the Folder this Display Group belongs to - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Display Group - `ref1` string — Optional Reference 1 - `ref2` string — Optional Reference 2 - `ref3` string — Optional Reference 3 - `ref4` string — Optional Reference 4 - `ref5` string — Optional Reference 5 - `xmrChannel` string — The Player Subscription Channel - `xmrPubKey` string — The Player Public Key - `lastCommandSuccess` integer — The last command success, 0 = failure, 1 = success, 2 = unknown - `deviceName` string — The Device Name for the device hardware associated with this Display - `timeZone` string — The Display Timezone, or empty to use the CMS timezone - `tags` TagLink[] — Tags associated with this Display, array of TagLink objects - `tag` string — The Tag - `tagId` integer — The Tag ID - `value` string — The Tag Value - `overrideConfig` unknown - `bandwidthLimit` integer — The display bandwidth limit - `newCmsAddress` string — The new CMS Address - `newCmsKey` string — The new CMS Key - `orientation` string — The orientation of the Display, either landscape or portrait - `resolution` string — The resolution of the Display expressed as a string in the format WxH - `commercialLicence` integer — Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable - `teamViewerSerial` string — The TeamViewer serial number for this Display - `webkeySerial` string — The Webkey serial number for this Display - `groupsWithPermissions` string — A comma separated list of groups/users with permissions to this Display - `createdDt` string — The datetime this entity was created - `modifiedDt` string — The datetime this entity was last modified - `folderId` integer — The id of the Folder this Display belongs to - `permissionsFolderId` integer — The id of the Folder responsible for providing permissions for this Display - `countFaults` integer — The count of Player reported faults - `lanIpAddress` string — LAN IP Address, if available on the Player - `syncGroupId` integer — The Display Group ID this Display is synced to - `osVersion` string — The OS version of the Display - `osSdk` string — The SDK version of the Display - `manufacturer` string — The manufacturer of the Display - `brand` string — The brand of the Display - `model` string — The model of the Display --- [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/fe497e811c7f/schema)