> 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/lists.md). # Lists Manage hierarchical list data ## GET /{app\_short}/lists/{list\_id} > Get a list with all its items ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItemPagedResponse":{"properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"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}/lists/{list_id}":{"get":{"tags":["lists"],"summary":"Get a list with all its items","operationId":"getList","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 1000)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"updated_since","in":"query","description":"Get only structure updated from this date","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"","pattern":"\\d+"}},{"name":"selectables_not_paginated","in":"query","description":"Get all list items","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"(1|0)"}},{"name":"max_depth","in":"query","description":"Max depth of items to retrieve (0 = all depth)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","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":"list_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Paginated list items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItemPagedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## List all lists (root identifiers only) > Returns every root list identifier of the workspace, without their child items. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListPagedResponse":{"properties":{"lists":{"type":"array","items":{"properties":{"created_at":{"type":"integer","format":"int64"},"list_last_updated":{"type":"integer","format":"int64"},"name":{"type":"string"},"root_id":{"type":"integer"}},"type":"object"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"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}/lists":{"get":{"tags":["lists"],"summary":"List all lists (root identifiers only)","description":"Returns every root list identifier of the workspace, without their child items.","operationId":"listLists","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 1000)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"10","pattern":"-?\\d+"}},{"name":"updated_since","in":"query","description":"Get only structure updated from this date","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"","pattern":"\\d+"}},{"name":"is_linked_to_structures","in":"query","description":"Get only list linked to structures","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"0","pattern":"[0|1]"}},{"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":"Paginated root list entries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPagedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Create a list > Creates a root node, with optional hierarchical children supplied through \`items\`. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListCreateRequest":{"required":["name"],"properties":{"external_id":{"type":"string"},"items":{"description":"Nested child items (recursive)","type":"array","items":{"$ref":"#/components/schemas/ListCreateRequest"}},"name":{"type":"string"}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"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}/lists":{"post":{"tags":["lists"],"summary":"Create a list","description":"Creates a root node, with optional hierarchical children supplied through `items`.","operationId":"createList","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"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCreateRequest"}}}},"responses":{"201":{"description":"Root list node created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItem"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Get the selectable item identifiers of a list > Returns every item the authenticated user is allowed to select, honouring the access sets. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/{list_id}/selectables":{"get":{"tags":["lists"],"summary":"Get the selectable item identifiers of a list","description":"Returns every item the authenticated user is allowed to select, honouring the access sets.","operationId":"getListSelectables","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":"list_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Selectable item identifiers","content":{"application/json":{"schema":{"properties":{"selectable_ids":{"type":"array","items":{"type":"integer"}},"server_time":{"type":"integer"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Get the modified list and access set identifiers > Returns the identifiers that have changed and need syncing. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/updated":{"post":{"tags":["lists"],"summary":"Get the modified list and access set identifiers","description":"Returns the identifiers that have changed and need syncing.","operationId":"getUpdatedLists","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"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Identifiers requiring an update","content":{"application/json":{"schema":{"properties":{"lists_to_update":{"type":"array","items":{"type":"integer"}},"lists_with_access_set":{"type":"array","items":{"type":"integer"}},"access_set_to_update":{"type":"array","items":{"type":"integer"}}},"type":"object"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Delete a complete list > Permanently removes the root node and all its children. The target must be a root node. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/{id}":{"delete":{"tags":["lists"],"summary":"Delete a complete list","description":"Permanently removes the root node and all its children. The target must be a root node.","operationId":"deleteList","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":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"204":{"description":"List deleted"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Edit list item names > Updates the \`name\` of one or more items identified by their \`id\`. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItemPagedResponse":{"properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"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}/lists/{id}":{"patch":{"tags":["lists"],"summary":"Edit list item names","description":"Updates the `name` of one or more items identified by their `id`.","operationId":"editListItems","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":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"required":["id","name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"type":"object"}}}}},"responses":{"200":{"description":"Updated items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItemPagedResponse"}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Delete a list item > Removes the item and all of its children, recursively. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/{id}/{item_id}":{"delete":{"tags":["lists"],"summary":"Delete a list item","description":"Removes the item and all of its children, recursively.","operationId":"deleteListItem","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":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"204":{"description":"Item deleted"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list item with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Get the image of a list item > Only available when \`has\_image\` is \`true\`. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/{id}/{item_id}/image":{"get":{"tags":["lists"],"summary":"Get the image of a list item","description":"Only available when `has_image` is `true`.","operationId":"getListItemImage","parameters":[{"name":"size","in":"query","description":"Image size","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"mix","pattern":"[a-z_\\-]+"}},{"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":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"name":"item_id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Image content","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list item with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Update a list item > \`\`\`\ > {\ > name: "xxxxx", // Required\ > latitude: xxxx,\ > longitude: xxxx,\ > external\_id: "xxx",\ > functionnal\_status\_color: "xxx,\ > url: "xxx"\ > }\ > \`\`\` ````json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItemUpdateRequest":{"properties":{"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"name":{"type":"string"},"url":{"type":"string"}},"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}/lists/{root_id}/{list_id}":{"put":{"tags":["lists"],"summary":"Update a list item","description":"```\n{\n name: \"xxxxx\", // Required\n latitude: xxxx,\n longitude: xxxx,\n external_id: \"xxx\",\n functionnal_status_color: \"xxx,\n url: \"xxx\"\n}\n```","operationId":"updateListItem","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":"root_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"list_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItemUpdateRequest"}}}},"responses":{"200":{"description":"Item updated","content":{"application/json":{"schema":{"type":"array","items":{}}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list item with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ```` ## Bulk add children to a node > Appends several child items to a parent node in a single request. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItemUpdateRequest":{"properties":{"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"name":{"type":"string"},"url":{"type":"string"}},"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}/lists/{root_id}/{parent_id}":{"patch":{"tags":["lists"],"summary":"Bulk add children to a node","description":"Appends several child items to a parent node in a single request.","operationId":"addListChildren","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":"root_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListItemUpdateRequest"}}}}},"responses":{"200":{"description":"Children added","content":{"application/json":{"schema":{"type":"array","items":{}}}}},"400":{"description":"The payload is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## GET /{app\_short}/lists/{root\_id}/child/{parent\_id} > Get the direct children of a node ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItemPagedResponse":{"properties":{"lists":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}},"next_page":{"type":"integer"},"server_time":{"type":"integer","format":"int64"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}},"type":"object"},"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"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}/lists/{root_id}/child/{parent_id}":{"get":{"tags":["lists"],"summary":"Get the direct children of a node","operationId":"getListChildren","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 1000)","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"1000","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":"root_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Direct child items","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItemPagedResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No list with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## POST /{app\_short}/lists/{root\_id}/search > Search list items by external identifier ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListItem":{"properties":{"all_items_readable":{"description":"Whether every descendant of this node is readable without an access set.","type":"boolean"},"created_at":{"type":"integer","format":"int64"},"deleted_at":{"description":"Deletion timestamp. Present only when the item has been deleted.","type":"integer","format":"int64"},"external_id":{"type":"string"},"functionnal_status_color":{"type":"string"},"has_image":{"type":"boolean"},"id":{"type":"integer"},"image_url":{"description":"URL of the item's image. Present only when `has_image` is true.","type":"string"},"latitude":{"type":"number"},"level":{"description":"Depth — 0 is the root node","type":"integer"},"longitude":{"type":"number"},"name":{"type":"string"},"parent_id":{"type":"integer"},"position":{"type":"integer"},"root_id":{"type":"integer"},"updated_at":{"type":"integer","format":"int64"},"url":{"type":"string"}},"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}/lists/{root_id}/search":{"post":{"tags":["lists"],"summary":"Search list items by external identifier","operationId":"searchListItems","parameters":[{"name":"external_id","in":"query","description":"searched external id.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"","pattern":"\\w+"}},{"name":"name","in":"query","description":"searched name.","required":false,"allowEmptyValue":false,"schema":{"type":"string","default":"","pattern":"\\w+"}},{"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":"root_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["external_id"],"properties":{"external_id":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Matching list items","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ListItem"}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## Reposition a list node > Moves a node relative to a reference node.\ > \ > \| \`direction\` | Effect |\ > \|---|---|\ > \| \`child\` | Becomes the first child of the reference node |\ > \| \`before\` | Placed just before the reference node, under the same parent |\ > \| \`after\` | Placed just after the reference node, under the same parent | ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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}/lists/{root_id}/{node_to_move_id}/{direction}/{node_position_id}":{"put":{"tags":["lists"],"summary":"Reposition a list node","description":"Moves a node relative to a reference node.\n\n| `direction` | Effect |\n|---|---|\n| `child` | Becomes the first child of the reference node |\n| `before` | Placed just before the reference node, under the same parent |\n| `after` | Placed just after the reference node, under the same parent |","operationId":"moveListNode","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":"root_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"node_to_move_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"direction","in":"path","required":true,"schema":{"type":"string"}},{"name":"node_position_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Node repositioned"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"description":"No node with this identifier in the workspace.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ``` ## Import a list from a CSV file (async) > Imports or diffs list data from a previously uploaded CSV file. Poll the returned \`callbackUrl\` for the status. ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"CallbackUrlResponse":{"properties":{"callbackUrl":{"description":"URL to poll for async job status","type":"string"}},"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}/lists/import":{"post":{"tags":["lists"],"summary":"Import a list from a CSV file (async)","description":"Imports or diffs list data from a previously uploaded CSV file. Poll the returned `callbackUrl` for the status.","operationId":"importList","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"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Async job accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallbackUrlResponse"}}}},"400":{"description":"Validation error: missing file identifier, wrong encoding, file not found…","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}} ``` ## GET /{app\_short}/lists/callback/{callback\_id} > Poll an async list job ```json {"openapi":"3.0.0","info":{"title":"Daxium Air API","version":"v1.3"},"tags":[{"name":"lists"}],"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":{"ListCallbackResponse":{"properties":{"callbackDetails":{"properties":{"errors":{"type":"array","items":{"type":"string"}},"nbErrors":{"type":"integer"},"nbRecordsDone":{"type":"integer"},"nbRecordsTodo":{"type":"integer"},"nbSuccess":{"type":"integer"},"status":{"type":"string","enum":["Planned","Running","Finished","Finished with errors","Failed"]},"success":{"type":"array","items":{}}},"type":"object"}},"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}/lists/callback/{callback_id}":{"get":{"tags":["lists"],"summary":"Poll an async list job","operationId":"getListCallback","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":"callback_id","in":"path","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/XAcceptVersion"}],"responses":{"200":{"description":"Job status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCallbackResponse"}}}},"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/lists.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.