> 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.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile":{"get":{"tags":["displayprofile"],"summary":"Display Profile Search","description":"Search this users Display Profiles","operationId":"displayProfileSearch","parameters":[{"name":"displayProfileId","in":"query","description":"Filter by DisplayProfile Id","required":false,"schema":{"type":"integer"}},{"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|linux|lg|sssp|chromeOS|hisense)","required":false,"schema":{"type":"string"}},{"name":"embed","in":"query","description":"Embed related data such as config,commands,configWithDefault","required":false,"schema":{"type":"string"}},{"name":"sortBy","in":"query","description":"Specifies which field the results are sorted by. Used together with sortDir","required":false,"schema":{"type":"string","enum":["displayProfileId","name","type","isDefault"]}},{"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/DisplayProfile"}}}}}}}}},"components":{"schemas":{"DisplayProfile":{"description":"Class 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"}}},"type":"object"}}}} ``` ## Add Display Profile > Add a Display Profile ```json {"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile":{"post":{"tags":["displayprofile"],"summary":"Add Display Profile","description":"Add a Display Profile","operationId":"displayProfileAdd","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","type","isDefault"],"properties":{"name":{"description":"The Name of the Display Profile","type":"string"},"type":{"description":"The Client Type this Profile will apply to","type":"string"},"isDefault":{"description":"Flag indicating if this is the default profile for the client type","type":"integer"}},"type":"object"}}}},"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayProfile"}}}}}}}},"components":{"schemas":{"DisplayProfile":{"description":"Class 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"}}},"type":"object"}}}} ``` ## Display Profile Search by ID > Get the Display Profile object specified by the provided displayProfileId ```json {"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile/{id}":{"get":{"tags":["displayprofile"],"summary":"Display Profile Search by ID","description":"Get the Display Profile object specified by the provided displayProfileId","operationId":"displayProfileSearchById","parameters":[{"name":"displayProfileId","in":"path","description":"Numeric ID of the Display Profile to get","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayProfile"}}}}}}}},"components":{"schemas":{"DisplayProfile":{"description":"Class 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"}}},"type":"object"}}}} ``` ## Edit Display Profile > Edit a Display Profile ```json {"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile/{displayProfileId}":{"put":{"tags":["displayprofile"],"summary":"Edit Display Profile","description":"Edit a Display Profile","operationId":"displayProfileEdit","parameters":[{"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["name","type","isDefault"],"properties":{"name":{"description":"The Name of the Display Profile","type":"string"},"type":{"description":"The Client Type this Profile will apply to","type":"string"},"isDefault":{"description":"Flag indicating if this is the default profile for the client type","type":"integer"}},"type":"object"}}}},"responses":{"204":{"description":"successful operation"}}}}}} ``` ## Delete Display Profile > Delete an existing Display Profile ```json {"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile/{displayProfileId}":{"delete":{"tags":["displayprofile"],"summary":"Delete Display Profile","description":"Delete an existing Display Profile","operationId":"displayProfileDelete","parameters":[{"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"successful operation"}}}}}} ``` ## Copy Display Profile > Copy an existing Display Profile ```json {"openapi":"3.0.0","info":{"title":"Xibo API","version":"4.5"},"tags":[{"name":"displayprofile","description":"Display Settings"}],"servers":[{"url":"/api"}],"paths":{"/displayprofile/{displayProfileId}/copy":{"post":{"tags":["displayprofile"],"summary":"Copy Display Profile","description":"Copy an existing Display Profile","operationId":"displayProfileCopy","parameters":[{"name":"displayProfileId","in":"path","description":"The Display Profile ID","required":true,"schema":{"type":"integer"}},{"name":"name","in":"path","description":"The name for the copy","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayProfile"}}}}}}}},"components":{"schemas":{"DisplayProfile":{"description":"Class 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"}}},"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/displayprofile.md?ask=&goal= ``` `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.