Lists

Manage hierarchical list data

List all lists (root IDs only)

get

Returns all root list identifiers in the workspace without their child items.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Query parameters

per_pageinteger · max: 1000OptionalDefault: 10

pageintegerOptionalDefault: 0

updated_sinceinteger · int64Optional

Return only lists updated after this date (including deleted ones)

Responses

200

Paginated root list entries

application/json

total_countintegerOptional

total_pagesintegerOptional

next_pageintegerOptional

server_timeinteger · int64Optional

get/{app_short}/lists

HTTPcURLJavaScriptPython

GET /{app_short}/lists HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated root list entries

{
  "lists": [
    {
      "root_id": 1,
      "name": "text",
      "created_at": 1,
      "list_last_updated": 1
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1
}

Create a list

post

Creates a root node with optional hierarchical children via items.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

namestringRequired

external_idstringOptional

Responses

201

Root list node created

application/json

idintegerOptional

root_idintegerOptional

parent_idintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

deleted_atinteger · int64 · nullableOptional

namestringOptional

has_imagebooleanOptional

levelintegerOptional

Depth — 0 is the root node

positionintegerOptional

external_idstringOptional

urlstringOptional

functionnal_status_colorstringOptional

post/{app_short}/lists

HTTPcURLJavaScriptPython

POST /{app_short}/lists HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "name": "text",
  "external_id": "text",
  "items": [
    {
      "name": "text",
      "external_id": "text",
      "items": [
        {
          "name": "text",
          "external_id": "text",
          "items": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

201

Root list node created

{
  "id": 1,
  "root_id": 1,
  "parent_id": 1,
  "created_at": 1,
  "updated_at": 1,
  "deleted_at": 1,
  "name": "text",
  "has_image": true,
  "level": 1,
  "position": 1,
  "external_id": "text",
  "url": "text",
  "functionnal_status_color": "text"
}

Import a list from CSV (async)

post

Imports or diffs list data from a previously uploaded CSV file. Poll the returned callbackUrl for status.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

list_idintegerRequired

file_idstring · uuidRequired

separatorstringOptionalDefault: ;

modestring · enumOptionalPossible values:

encodingstring · enumOptionalDefault: UTF-8Possible values:

Responses

200

Async job accepted

application/json

callbackUrlstringOptional

URL to poll for async job status

400

Validation error (missing file_id, bad encoding, file not found, etc.)

application/json

post/{app_short}/lists/import

HTTPcURLJavaScriptPython

POST /{app_short}/lists/import HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "list_id": 1,
  "file_id": "123e4567-e89b-12d3-a456-426614174000",
  "separator": ";",
  "mode": "APPEND",
  "encoding": "UTF-8"
}

{
  "callbackUrl": "text"
}

Get modified list and access-set IDs

post

Returns IDs of lists and access sets that have changed and need syncing.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

Responses

200

IDs of lists and access sets requiring an update

application/json

lists_to_updateinteger[]Optional

lists_with_access_setinteger[]Optional

access_set_to_updateinteger[]Optional

post/{app_short}/lists/updated

HTTPcURLJavaScriptPython

POST /{app_short}/lists/updated HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "list_states": [
    {
      "list_id": 1,
      "list_updated_since": 1,
      "access_set_updated_since": 1
    }
  ]
}

200

IDs of lists and access sets requiring an update

{
  "lists_to_update": [
    1
  ],
  "lists_with_access_set": [
    1
  ],
  "access_set_to_update": [
    1
  ]
}

Poll async list job status

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

callback_idstring · uuidRequired

Responses

200

Job status

application/json

get/{app_short}/lists/callback/{callback_id}

HTTPcURLJavaScriptPython

GET /{app_short}/lists/callback/{callback_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Job status

{
  "callbackDetails": {
    "status": "Planned",
    "nbRecordsTodo": 1,
    "nbRecordsDone": 1,
    "nbSuccess": 1,
    "nbErrors": 1,
    "success": [],
    "errors": [
      "text"
    ]
  }
}

Get a list with all its items

get

Returns the list and all child items with pagination.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

Query parameters

per_pageinteger · max: 1000Optional

pageintegerOptional

updated_sinceinteger · int64Optional

Return only items updated after this date (including deleted ones)

Responses

200

Paginated list items

application/json

total_countintegerOptional

total_pagesintegerOptional

next_pageintegerOptional

server_timeinteger · int64Optional

get/{app_short}/lists/{list_id}

HTTPcURLJavaScriptPython

GET /{app_short}/lists/{list_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Paginated list items

{
  "lists": [
    {
      "id": 1,
      "root_id": 1,
      "parent_id": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "name": "text",
      "has_image": true,
      "level": 1,
      "position": 1,
      "external_id": "text",
      "url": "text",
      "functionnal_status_color": "text"
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1
}

Delete a complete list

delete

Permanently removes the root node and all children. Target must be a root node.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

Responses

204

List deleted

No content

delete/{app_short}/lists/{list_id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/lists/{list_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

List deleted

No content

Edit list item names

patch

Updates the name of one or more items identified by their id. Send an array of {id, name} objects.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

Root node identifier

Bodyobject[]

application/json

idintegerRequired

namestringRequired

Responses

200

Updated items

application/json

total_countintegerOptional

total_pagesintegerOptional

next_pageintegerOptional

server_timeinteger · int64Optional

patch/{app_short}/lists/{root_id}

HTTPcURLJavaScriptPython

PATCH /{app_short}/lists/{root_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

[
  {
    "id": 1,
    "name": "text"
  }
]

200

Updated items

{
  "lists": [
    {
      "id": 1,
      "root_id": 1,
      "parent_id": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "name": "text",
      "has_image": true,
      "level": 1,
      "position": 1,
      "external_id": "text",
      "url": "text",
      "functionnal_status_color": "text"
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1
}

Get selectable item IDs for a list

get

Returns all item IDs the authenticated user can select, respecting access sets.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

list_idintegerRequired

Responses

200

Selectable item IDs

application/json

selectable_idsinteger[]Optional

server_timeinteger · int64Optional

get/{app_short}/lists/{list_id}/selectables

HTTPcURLJavaScriptPython

GET /{app_short}/lists/{list_id}/selectables HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Selectable item IDs

{
  "selectable_ids": [
    1
  ],
  "server_time": 1
}

Search list items by external_id

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

Body

application/json

external_idstringRequired

Responses

200

Matching list items

application/json

idintegerOptional

root_idintegerOptional

parent_idintegerOptional

created_atinteger · int64Optional

updated_atinteger · int64Optional

deleted_atinteger · int64 · nullableOptional

namestringOptional

has_imagebooleanOptional

levelintegerOptional

Depth — 0 is the root node

positionintegerOptional

external_idstringOptional

urlstringOptional

functionnal_status_colorstringOptional

post/{app_short}/lists/{root_id}/search

HTTPcURLJavaScriptPython

POST /{app_short}/lists/{root_id}/search HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "external_id": "text"
}

200

Matching list items

[
  {
    "id": 1,
    "root_id": 1,
    "parent_id": 1,
    "created_at": 1,
    "updated_at": 1,
    "deleted_at": 1,
    "name": "text",
    "has_image": true,
    "level": 1,
    "position": 1,
    "external_id": "text",
    "url": "text",
    "functionnal_status_color": "text"
  }
]

Get direct children of a node

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

parent_idintegerRequired

Responses

200

Direct child items

application/json

total_countintegerOptional

total_pagesintegerOptional

next_pageintegerOptional

server_timeinteger · int64Optional

get/{app_short}/lists/{root_id}/child/{parent_id}

HTTPcURLJavaScriptPython

GET /{app_short}/lists/{root_id}/child/{parent_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Direct child items

{
  "lists": [
    {
      "id": 1,
      "root_id": 1,
      "parent_id": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "name": "text",
      "has_image": true,
      "level": 1,
      "position": 1,
      "external_id": "text",
      "url": "text",
      "functionnal_status_color": "text"
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1
}

Update a list item

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

list_idintegerRequired

Body

application/json

namestringOptional

latitudenumber · floatOptional

longitudenumber · floatOptional

external_idstringOptional

functionnal_status_colorstringOptional

urlstringOptional

Responses

200

Item updated

application/json

itemsanyOptional

put/{app_short}/lists/{root_id}/{list_id}

HTTPcURLJavaScriptPython

PUT /{app_short}/lists/{root_id}/{list_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "name": "text",
  "latitude": 1,
  "longitude": 1,
  "external_id": "text",
  "functionnal_status_color": "text",
  "url": "text"
}

200

Item updated

[]

Delete a list item

delete

Removes the item and all its children recursively.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

list_idintegerRequired

Responses

204

Item deleted

No content

delete/{app_short}/lists/{root_id}/{list_id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/lists/{root_id}/{list_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Item deleted

No content

Bulk add children to a node

patch

Appends multiple children to a parent node in one request.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

list_idintegerRequired

Parent node identifier

Bodyobject · ListItemUpdateRequest[]

application/json

namestringOptional

latitudenumber · floatOptional

longitudenumber · floatOptional

external_idstringOptional

functionnal_status_colorstringOptional

urlstringOptional

Responses

200

Children added

application/json

itemsanyOptional

patch/{app_short}/lists/{root_id}/{list_id}

HTTPcURLJavaScriptPython

PATCH /{app_short}/lists/{root_id}/{list_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

[
  {
    "name": "text",
    "latitude": 1,
    "longitude": 1,
    "external_id": "text",
    "functionnal_status_color": "text",
    "url": "text"
  }
]

200

Children added

[]

Get the image for a list item

get

Returns the image — only when has_image is true.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

list_idintegerRequired

Responses

200

Image content

image/jpeg

string · binaryOptional

get/{app_short}/lists/{root_id}/{list_id}/image

HTTPcURLJavaScriptPython

GET /{app_short}/lists/{root_id}/{list_id}/image HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Image content

binary

Reposition a list node

put

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 (same parent)
after	Placed just after the reference node (same parent)

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

root_idintegerRequired

node_to_move_idintegerRequired

directionstring · enumRequiredPossible values:

node_position_idintegerRequired

Reference node for placement

Responses

200

Node repositioned

No content

put/{app_short}/lists/{root_id}/{node_to_move_id}/{direction}/{node_position_id}

HTTPcURLJavaScriptPython

PUT /{app_short}/lists/{root_id}/{node_to_move_id}/{direction}/{node_position_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Node repositioned

No content