> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/sync-group.md).

# Sync Group

syncGroup

## Search Sync Groups

> Search for Sync Groups viewable by this user

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroups":{"get":{"tags":["syncGroup"],"summary":"Search Sync Groups","description":"Search for Sync Groups viewable by this user","operationId":"syncGroupSearch","parameters":[{"name":"syncGroupId","in":"query","description":"Filter by syncGroup Id","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by partial Sync Group name","required":false,"schema":{"type":"string"}},{"name":"ownerId","in":"query","description":"Filter by Owner ID","required":false,"schema":{"type":"integer"}},{"name":"folderId","in":"query","description":"Filter by Folder ID","required":false,"schema":{"type":"integer"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["syncGroupId","name","owner","createdDt","modifiedDt"]}},{"name":"sortDir","in":"query","description":"Sort direction","required":false,"schema":{"type":"string","enum":["asc","desc"]}}],"responses":{"200":{"description":"successful operation","headers":{"X-Total-Count":{"description":"The total number of records","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SyncGroup"}}}}}}}}},"components":{"schemas":{"SyncGroup":{"description":"Class SyncGroup","properties":{"syncGroupId":{"description":"The ID of this Entity","type":"integer"},"name":{"description":"The name of this Entity","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string","nullable":true},"modifiedBy":{"description":"The ID of the user that last modified this sync group","type":"integer"},"modifiedByName":{"description":"The name of the user that last modified this sync group","type":"string"},"ownerId":{"description":"The ID of the owner of this sync group","type":"integer"},"owner":{"description":"The name of the owner of this sync group","type":"string"},"syncPublisherPort":{"description":"The publisher port number","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start.","type":"integer"},"leadDisplayId":{"description":"The ID of the lead Display for this sync group","type":"integer"},"leadDisplay":{"description":"The name of the lead Display for this sync group","type":"string"},"folderId":{"description":"The id of the Folder this Sync Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Sync Group","type":"integer"}},"type":"object"}}}}
```

## Search Sync Groups by ID

> Get the Sync Group object specified by the provided syncGroupId

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/{syncGroupId}":{"get":{"tags":["syncGroup"],"summary":"Search Sync Groups by ID","description":"Get the Sync Group object specified by the provided syncGroupId","operationId":"syncGroupSearchById","parameters":[{"name":"syncGroupId","in":"path","description":"Numeric ID of the Sync Group to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncGroup"}}}}}}}},"components":{"schemas":{"SyncGroup":{"description":"Class SyncGroup","properties":{"syncGroupId":{"description":"The ID of this Entity","type":"integer"},"name":{"description":"The name of this Entity","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string","nullable":true},"modifiedBy":{"description":"The ID of the user that last modified this sync group","type":"integer"},"modifiedByName":{"description":"The name of the user that last modified this sync group","type":"string"},"ownerId":{"description":"The ID of the owner of this sync group","type":"integer"},"owner":{"description":"The name of the owner of this sync group","type":"string"},"syncPublisherPort":{"description":"The publisher port number","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start.","type":"integer"},"leadDisplayId":{"description":"The ID of the lead Display for this sync group","type":"integer"},"leadDisplay":{"description":"The name of the lead Display for this sync group","type":"string"},"folderId":{"description":"The id of the Folder this Sync Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Sync Group","type":"integer"}},"type":"object"}}}}
```

## Add a Sync Group

> Add a new Sync Group to the CMS

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/add":{"post":{"tags":["syncGroup"],"summary":"Add a Sync Group","description":"Add a new Sync Group to the CMS","operationId":"syncGroupAdd","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name"],"properties":{"name":{"description":"The Sync Group Name","type":"string"},"syncPublisherPort":{"description":"The publisher port number on which sync group members will communicate - default 9590","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content - default 750","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start - default 100","type":"integer"},"folderId":{"description":"Folder ID to which this object should be assigned to","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new SyncGroup","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncGroup"}}}}}}}},"components":{"schemas":{"SyncGroup":{"description":"Class SyncGroup","properties":{"syncGroupId":{"description":"The ID of this Entity","type":"integer"},"name":{"description":"The name of this Entity","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string","nullable":true},"modifiedBy":{"description":"The ID of the user that last modified this sync group","type":"integer"},"modifiedByName":{"description":"The name of the user that last modified this sync group","type":"string"},"ownerId":{"description":"The ID of the owner of this sync group","type":"integer"},"owner":{"description":"The name of the owner of this sync group","type":"string"},"syncPublisherPort":{"description":"The publisher port number","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start.","type":"integer"},"leadDisplayId":{"description":"The ID of the lead Display for this sync group","type":"integer"},"leadDisplay":{"description":"The name of the lead Display for this sync group","type":"string"},"folderId":{"description":"The id of the Folder this Sync Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Sync Group","type":"integer"}},"type":"object"}}}}
```

## Assign one or more Displays to a Sync Group

> Adds the provided Displays to the Sync Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/{syncGroupId}/members":{"post":{"tags":["syncGroup"],"summary":"Assign one or more Displays to a Sync Group","description":"Adds the provided Displays to the Sync Group","operationId":"syncGroupMembers","parameters":[{"name":"syncGroupId","in":"path","description":"The Sync Group to assign to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["displayId"],"properties":{"displayId":{"description":"The Display Ids to assign","type":"array","items":{"type":"integer"}},"unassignDisplayId":{"description":"An optional array of Display IDs to unassign","type":"array","items":{"type":"integer"}}},"type":"object"}}}},"responses":{"204":{"description":"successful operation"}}}}}}
```

## Edit a Sync Group

> Edit an existing Sync Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/{syncGroupId}/edit":{"post":{"tags":["syncGroup"],"summary":"Edit a Sync Group","description":"Edit an existing Sync Group","operationId":"syncGroupEdit","parameters":[{"name":"syncGroupId","in":"path","description":"The Sync Group to edit","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","leadDisplayId"],"properties":{"name":{"description":"The Sync Group Name","type":"string"},"syncPublisherPort":{"description":"The publisher port number on which sync group members will communicate - default 9590","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content - default 750","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start - default 100","type":"integer"},"leadDisplayId":{"description":"The ID of the Display that belongs to this Sync Group and should act as a Lead Display","type":"integer"},"folderId":{"description":"Folder ID to which this object should be assigned to","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new SyncGroup","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncGroup"}}}}}}}},"components":{"schemas":{"SyncGroup":{"description":"Class SyncGroup","properties":{"syncGroupId":{"description":"The ID of this Entity","type":"integer"},"name":{"description":"The name of this Entity","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string","nullable":true},"modifiedBy":{"description":"The ID of the user that last modified this sync group","type":"integer"},"modifiedByName":{"description":"The name of the user that last modified this sync group","type":"string"},"ownerId":{"description":"The ID of the owner of this sync group","type":"integer"},"owner":{"description":"The name of the owner of this sync group","type":"string"},"syncPublisherPort":{"description":"The publisher port number","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start.","type":"integer"},"leadDisplayId":{"description":"The ID of the lead Display for this sync group","type":"integer"},"leadDisplay":{"description":"The name of the lead Display for this sync group","type":"string"},"folderId":{"description":"The id of the Folder this Sync Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Sync Group","type":"integer"}},"type":"object"}}}}
```

## Delete a Sync Group

> Delete an existing Sync Group identified by its Id

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/{syncGroupId}/delete":{"delete":{"tags":["syncGroup"],"summary":"Delete a Sync Group","description":"Delete an existing Sync Group identified by its Id","operationId":"syncGroupDelete","parameters":[{"name":"syncGroupId","in":"path","description":"The syncGroupId to delete","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Get Sync Group members

> Get the Display members of the specified Sync Group

```json
{"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"syncGroup","description":"syncGroup"}],"servers":[{"url":"/api"}],"paths":{"/syncgroup/{syncGroupId}/displays":{"get":{"tags":["syncGroup"],"summary":"Get Sync Group members","description":"Get the Display members of the specified Sync Group","operationId":"syncGroupDisplays","parameters":[{"name":"syncGroupId","in":"path","description":"The ID of the Sync Group to get members for","required":true,"schema":{"type":"integer"}},{"name":"eventId","in":"query","description":"Filter by event ID - return will include Layouts Ids scheduled against each group member","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SyncGroup"}}}}}}}}},"components":{"schemas":{"SyncGroup":{"description":"Class SyncGroup","properties":{"syncGroupId":{"description":"The ID of this Entity","type":"integer"},"name":{"description":"The name of this Entity","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string","nullable":true},"modifiedBy":{"description":"The ID of the user that last modified this sync group","type":"integer"},"modifiedByName":{"description":"The name of the user that last modified this sync group","type":"string"},"ownerId":{"description":"The ID of the owner of this sync group","type":"integer"},"owner":{"description":"The name of the owner of this sync group","type":"string"},"syncPublisherPort":{"description":"The publisher port number","type":"integer"},"syncSwitchDelay":{"description":"The delay (in ms) when displaying the changes in content","type":"integer"},"syncVideoPauseDelay":{"description":"The delay (in ms) before unpausing the video on start.","type":"integer"},"leadDisplayId":{"description":"The ID of the lead Display for this sync group","type":"integer"},"leadDisplay":{"description":"The name of the lead Display for this sync group","type":"string"},"folderId":{"description":"The id of the Folder this Sync Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Sync Group","type":"integer"}},"type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/sync-group.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.