> 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/displayprofile.md).

# Displayprofile

Display Settings

## Display Profile Search

> Search this users Display Profiles

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"DisplayProfile":{"properties":{"displayProfileId":{"description":"The ID of this Display Profile","type":"integer"},"name":{"description":"The name of this Display Profile","type":"string"},"type":{"description":"The player type that this Display Profile is for","type":"string"},"config":{"description":"The configuration options for this Profile","type":"array","items":{"type":"string"}},"isDefault":{"description":"A flag indicating if this profile should be used as the Default for the client type","type":"integer"},"userId":{"description":"The userId of the User that owns this profile","type":"integer"},"configDefault":{"description":"The default configuration options for this Profile","type":"array","items":{"type":"string"}}}}}},"paths":{"/displayprofile":{"get":{"tags":["displayprofile"],"summary":"Display Profile Search","description":"Search this users Display Profiles","operationId":"displayProfileSearch","parameters":[{"schema":{"type":"integer"},"name":"displayProfileId","in":"query","description":"Filter by DisplayProfile Id","required":false},{"schema":{"type":"string"},"name":"displayProfile","in":"query","description":"Filter by DisplayProfile Name","required":false},{"schema":{"type":"string"},"name":"type","in":"query","description":"Filter by DisplayProfile Type (windows|android|lg)","required":false},{"schema":{"type":"string"},"name":"embed","in":"query","description":"Embed related data such as config,commands,configWithDefault","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DisplayProfile"}}}}}}}}}}
```

## Add Display Profile

> Add a Display Profile

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"DisplayProfile":{"properties":{"displayProfileId":{"description":"The ID of this Display Profile","type":"integer"},"name":{"description":"The name of this Display Profile","type":"string"},"type":{"description":"The player type that this Display Profile is for","type":"string"},"config":{"description":"The configuration options for this Profile","type":"array","items":{"type":"string"}},"isDefault":{"description":"A flag indicating if this profile should be used as the Default for the client type","type":"integer"},"userId":{"description":"The userId of the User that owns this profile","type":"integer"},"configDefault":{"description":"The default configuration options for this Profile","type":"array","items":{"type":"string"}}}}}},"paths":{"/displayprofile":{"post":{"tags":["displayprofile"],"summary":"Add Display Profile","description":"Add a Display Profile","operationId":"displayProfileAdd","responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayProfile"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The Name of the Display Profile"},"type":{"type":"string","description":"The Client Type this Profile will apply to"},"isDefault":{"type":"integer","description":"Flag indicating if this is the default profile for the client type"}},"required":["name","type","isDefault"]}}}}}}}}
```

## Edit Display Profile

> Edit a Display Profile

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/displayprofile/{displayProfileId}":{"put":{"tags":["displayprofile"],"summary":"Edit Display Profile","description":"Edit a Display Profile","operationId":"displayProfileEdit","parameters":[{"schema":{"type":"integer"},"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true}],"responses":{"204":{"description":"successful operation"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The Name of the Display Profile"},"type":{"type":"string","description":"The Client Type this Profile will apply to"},"isDefault":{"type":"integer","description":"Flag indicating if this is the default profile for the client type"}},"required":["name","type","isDefault"]}}}}}}}}
```

## Delete Display Profile

> Delete an existing Display Profile

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/displayprofile/{displayProfileId}":{"delete":{"tags":["displayprofile"],"summary":"Delete Display Profile","description":"Delete an existing Display Profile","operationId":"displayProfileDelete","parameters":[{"schema":{"type":"integer"},"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```

## Copy Display Profile

> Copy an existing Display Profile

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"DisplayProfile":{"properties":{"displayProfileId":{"description":"The ID of this Display Profile","type":"integer"},"name":{"description":"The name of this Display Profile","type":"string"},"type":{"description":"The player type that this Display Profile is for","type":"string"},"config":{"description":"The configuration options for this Profile","type":"array","items":{"type":"string"}},"isDefault":{"description":"A flag indicating if this profile should be used as the Default for the client type","type":"integer"},"userId":{"description":"The userId of the User that owns this profile","type":"integer"},"configDefault":{"description":"The default configuration options for this Profile","type":"array","items":{"type":"string"}}}}}},"paths":{"/displayprofile/{displayProfileId}/copy":{"post":{"tags":["displayprofile"],"summary":"Copy Display Profile","description":"Copy an existing Display Profile","operationId":"displayProfileCopy","parameters":[{"schema":{"type":"integer"},"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true},{"schema":{"type":"string"},"name":"name","in":"path","description":"The name for the copy","required":true}],"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayProfile"}}}}}}}}}
```


---

# 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/displayprofile.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.