listScreenGroups

GET

/api/v1/screen-groups

const url = 'https://example.com/api/v1/screen-groups';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/screen-groups

List screen groups. Requires an authenticated dashboard user.

Parameters

Query Parameters

page

integer

>= 1

pageSize

integer

>= 1 <= 100

search

string

Responses

200

Paginated Display Groups, assignments, and members

application/json

object

data

required

object

items

required

Array<object>

object

required

string format: uuid

name

required

string

description

required

string

displayMode

required

string

Allowed values: mirror span

presentationGatewayScreenId

string format: uuid

playlistId

string format: uuid

playlistName

string

layoutId

string format: uuid

layoutName

string

presentationType

string

Allowed values: playlist layout

playbackEpoch

required

string format: date-time

membershipCount

required

integer

screens

required

Array<object>

object

required

string format: uuid

name

required

string

location

required

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

total

required

integer

page

required

integer

>= 1

pageSize

required

integer

>= 1

Example

{
  "data": {
    "items": [
      {
        "displayMode": "mirror",
        "presentationType": "playlist"
      }
    ]
  }
}