---
title: "Get Display Groups"
method: GET
path: "/displaygroup"
tags: ["displayGroup"]
---

# Get Display Groups

`GET /displaygroup`

## Query parameters

- `displayGroupId` integer
- `displayGroup` string
- `displayId` integer
- `nestedDisplayId` integer
- `dynamicCriteria` string
- `tags` string
- `exactTags` integer
- `logicalOperator` string
- `isDisplaySpecific` integer
- `forSchedule` integer
- `folderId` integer
- `sortBy` 'displayGroupId' | 'displayGroup' | 'description' | 'isDynamic' | 'dynamicCriteria' | 'dynamicCriteriaTags' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5' | 'createdDt' | 'modifiedDt' | 'groupsWithPermissions'
- `sortDir` 'asc' | 'desc'

## Response `200`

a successful response

- DisplayGroup[]
  - `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

---

[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/versions/fe497e811c7f/schema)
