> For the complete documentation index, see [llms.txt](https://www.center.daxium-air.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.center.daxium-air.com/api-reference/custom-applications.md). # Custom Applications Retrieve custom mobile application configurations ## List custom apps > Returns all custom applications in short format. When none is configured, returns the default application in full format. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"customapps"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"CustomAppSummary":{"description":"Custom app as returned in the list view, and the common base of the detailed `CustomApp` object.","properties":{"banner":{"type":"object","additionalProperties":true},"created_at":{"type":"integer","format":"int64"},"groups":{"type":"array","items":{}},"id":{"type":"integer"},"logo":{"description":"Logo file UUID","type":"string"},"menus":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"icon":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"index":{"type":"integer"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"name":{"type":"string"},"screens":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"name":{"type":"string"},"pages":{"type":"array","items":{"properties":{"layout":{"type":"array","items":{"properties":{"height":{"type":"integer"},"width":{"type":"integer"},"x":{"type":"integer"},"y":{"type":"integer"}},"type":"object"}},"side_menu":{"type":"boolean"},"system_name":{"type":"string"},"title":{"type":"object","additionalProperties":{"type":"string"}},"widgets":{"type":"array","items":{"properties":{"background":{"description":"Background image UUID (full button type)","type":"string"},"color":{"type":"string"},"icon":{"type":"object","additionalProperties":true},"index":{"type":"integer"},"label":{"type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"type":"object"}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"settings":{"type":"array","items":{}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/customapps":{"get":{"tags":["customapps"],"summary":"List custom apps","description":"Returns all custom applications in short format. When none is configured, returns the default application in full format.","operationId":"listCustomApps","parameters":[{"name":"page","in":"query","description":"Page of the overview.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"\\d+"}},{"name":"per_page","in":"query","description":"Number of result by page (Max 100)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"List of custom apps","content":{"application/json":{"schema":{"properties":{"apps":{"type":"array","items":{"$ref":"#/components/schemas/CustomAppSummary"}},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## GET /{app\_short}/customapps/{app\_id} > Get a custom app ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"customapps"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"schemas":{"CustomApp":{"description":"Full detail of a custom app, returned when fetching a single app. Adds fields not present in the list view (`CustomAppSummary`).","allOf":[{"$ref":"#/components/schemas/CustomAppSummary"},{"properties":{"button_type":{"description":"`standard` = Font Awesome icon, `mix` = image icon, `full` = background image","type":"string","enum":["standard","mix","full"]},"grant_all":{"type":"boolean"},"label_overlay":{"type":"boolean"},"splash":{"properties":{"active":{"type":"boolean"},"aspect":{"type":"string","enum":["fit","fill"]},"color":{"type":"string"},"created_at":{"type":"integer","format":"int64"},"image":{"description":"Image file UUID","type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"},"widget_spacing":{"description":"`0` = flat mode, `1` = standard","type":"integer","enum":[0,1]}},"type":"object"}]},"CustomAppSummary":{"description":"Custom app as returned in the list view, and the common base of the detailed `CustomApp` object.","properties":{"banner":{"type":"object","additionalProperties":true},"created_at":{"type":"integer","format":"int64"},"groups":{"type":"array","items":{}},"id":{"type":"integer"},"logo":{"description":"Logo file UUID","type":"string"},"menus":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"icon":{"properties":{"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"index":{"type":"integer"},"label":{"description":"Localised labels keyed by locale (e.g. `fr`, `en`)","type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"name":{"type":"string"},"screens":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"name":{"type":"string"},"pages":{"type":"array","items":{"properties":{"layout":{"type":"array","items":{"properties":{"height":{"type":"integer"},"width":{"type":"integer"},"x":{"type":"integer"},"y":{"type":"integer"}},"type":"object"}},"side_menu":{"type":"boolean"},"system_name":{"type":"string"},"title":{"type":"object","additionalProperties":{"type":"string"}},"widgets":{"type":"array","items":{"properties":{"background":{"description":"Background image UUID (full button type)","type":"string"},"color":{"type":"string"},"icon":{"type":"object","additionalProperties":true},"index":{"type":"integer"},"label":{"type":"object","additionalProperties":{"type":"string"}},"target":{"type":"string"},"type":{"type":"string"}},"type":"object"}}},"type":"object"}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"}},"settings":{"type":"array","items":{}},"updated_at":{"type":"integer","format":"int64"}},"type":"object"},"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{app_short}/customapps/{app_id}":{"get":{"tags":["customapps"],"summary":"Get a custom app","operationId":"getCustomApp","parameters":[{"name":"updated_at","in":"query","description":"Results updated since this date","required":false,"allowEmptyValue":true,"schema":{"type":"string","default":null,"pattern":"\\d+"}},{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Custom app details","content":{"application/json":{"schema":{"properties":{"app":{"$ref":"#/components/schemas/CustomApp"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"},"server_time":{"type":"integer"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No custom app with this identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## GET /{app\_short}/customapps/{app\_id}/file/{uuid} > Get a file from a custom app ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"customapps"}],"servers":[{"url":"https://api.daxium-air.com","description":"Production"}],"security":[{"oauth2":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Send the access token as `Authorization: Bearer `.","flows":{"password":{"tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/v2/auth","tokenUrl":"/oauth/v2/token","refreshUrl":"/oauth/v2/token","scopes":{}}}}},"parameters":{"XAcceptVersion":{"name":"X-Accept-Version","in":"header","description":"API version to apply. Defaults to `v1.0` when omitted; an unknown value falls back to the latest version.","required":false,"schema":{"type":"string","default":"v1.3","enum":["v1.0","v1.1","v1.2","v1.3"]}}},"responses":{"Unauthorized":{"description":"Missing or invalid access token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"description":"Standardised error body returned by the REST exception subscriber.","properties":{"code":{"description":"Daxium error code.","type":"string"},"message":{"type":"string"},"url":{"description":"Link to the error code in the error reference.","type":"string"},"api_version":{"type":"string"},"infos":{"description":"Additional context about the error, when the exception carries any.","type":"array","items":{}},"server_time":{"type":"integer"}},"type":"object"}}},"paths":{"/{app_short}/customapps/{app_id}/file/{uuid}":{"get":{"tags":["customapps"],"summary":"Get a file from a custom app","operationId":"getCustomAppFile","parameters":[{"name":"app_short","in":"path","description":"Short name of the workspace, as found in the URL of the back-office.","required":true,"schema":{"type":"string"}},{"name":"app_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"name":"uuid","in":"path","required":true,"schema":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Binary file content","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://www.center.daxium-air.com/api-reference/custom-applications.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.