For the complete documentation index, see llms.txt. This page is also available as Markdown.

Submissions

Create, read, update, delete and search records

List the submissions assigned to the authenticated user

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
pagestringOptional

Page of the overview.

Default: 0Pattern: \d+
per_pagestringOptional

Number of result by page (Max 100)

Default: 10Pattern: -?\d+
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

Paginated list of the submissions assigned to the authenticated user.

application/json

Envelope shared by every paginated collection, alongside the collection itself.

server_timeintegerOptional

Server timestamp at the moment the response was built.

total_countintegerOptional

Total number of items matching the request, across all pages.

total_pagesintegerOptional
next_pageintegerOptional

Index of the next page. Absent on the last one.

get/{app_short}/submissions/assigned/me
GET /{app_short}/submissions/assigned/me HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "server_time": 1,
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channels": [
        "text"
      ],
      "user_id": 1,
      "last_updated_user_id": 1,
      "assigned_user": {},
      "user": {},
      "subscribers": [
        "text"
      ],
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "settings": {},
      "task_id": "123e4567-e89b-12d3-a456-426614174000",
      "data_created_at": 1,
      "data_updated_at": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "read_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

List submissions

get

Results are restricted to the forms the authenticated user has access to in the workspace.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
structure_idstringOptional

Form identifier (required unless reference=true).

Default: nullPattern: \d+
pagestringOptional

Page of the overview.

Default: 0Pattern: \d+
per_pagestringOptional

Number of result by page (Max 100)

Default: 10Pattern: -?\d+
referencestringOptional

Fetch reference data

Default: nullPattern: true|false
updated_sincestringOptional

Results updated since this date

Default: nullPattern: \d+
user_idstringOptional

Filter by user ID

Default: null
last_updated_user_idstringOptional

Filter by last updated user ID

Default: null
items_expandedstringOptional

Get full items list or user

Default: nullPattern: true|false
expanded_typesstringOptional

set expanded items types

Default: nullPattern: [a-z,]+
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

Paginated list of submissions.

application/json

Envelope shared by every paginated collection, alongside the collection itself.

server_timeintegerOptional

Server timestamp at the moment the response was built.

total_countintegerOptional

Total number of items matching the request, across all pages.

total_pagesintegerOptional
next_pageintegerOptional

Index of the next page. Absent on the last one.

get/{app_short}/submissions
GET /{app_short}/submissions HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "server_time": 1,
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channels": [
        "text"
      ],
      "user_id": 1,
      "last_updated_user_id": 1,
      "assigned_user": {},
      "user": {},
      "subscribers": [
        "text"
      ],
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "settings": {},
      "task_id": "123e4567-e89b-12d3-a456-426614174000",
      "data_created_at": 1,
      "data_updated_at": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "read_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create a submission

post

For image, signature and file fields, upload the file first and use the returned UUID here.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
partialstringOptional

Allow partial mode

Default: falsePattern: true|false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
created_atinteger · int64Optional

Defaults to now

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired
structure_versionintegerRequired
substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

updated_atinteger · int64Optional

Defaults to now

Responses
200

Submission created

application/json
idstring · uuidOptional
structure_idintegerOptional

Identifier of the form.

structure_versionintegerOptional

Version of the form the submission was filled against.

channelsstring[]Optional

Broadcasts matched by the submission.

user_idintegerOptional

Owner of the submission.

last_updated_user_idintegerOptional

User who last modified the submission.

assigned_userobjectOptional

User the submission is assigned to. Present only when it is assigned.

userobjectOptional

The owner of the submission — same object shape as assigned_user. Only present when the request carries items_expanded=true; absent on the list and search endpoints regardless of that parameter.

subscribersstring[]Optional

Users subscribed to the submission.

current_statestring · uuidOptional

Workflow state the submission currently sits in.

submission_numberintegerOptional

Sequential number across the workspace.

number_in_structureintegerOptional

Sequential number within the form.

latitudenumberOptional
longitudenumberOptional
settingsobjectOptional
task_idstring · uuidOptional

Task the submission belongs to, when there is one.

data_created_atintegerOptional

Creation timestamp of the data on the server.

data_updated_atintegerOptional

Last update timestamp of the data on the server.

created_atintegerOptional
updated_atintegerOptional
deleted_atintegerOptional

Deletion timestamp. Present only when the submission has been deleted.

read_atstring · date-timeOptional

When the submission was marked as read. Present only once that has happened.

post/{app_short}/submissions
POST /{app_short}/submissions HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "created_at": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "structure_id": 1,
  "structure_version": 1,
  "substitute_user_id": 1,
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": 1
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "channels": [
    "text"
  ],
  "user_id": 1,
  "last_updated_user_id": 1,
  "assigned_user": {},
  "user": {},
  "subscribers": [
    "text"
  ],
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "settings": {},
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "data_created_at": 1,
  "data_updated_at": 1,
  "created_at": 1,
  "updated_at": 1,
  "deleted_at": 1,
  "read_at": "2026-01-01T00:00:00.000Z"
}

Search submissions

post

Returns the submissions matching field-level criteria. A field can appear only once, and the case of the operators is significant.

Operator
Compatible field types

equal / notequal

text, number, boolean, date, email, phone

isNull / isNotNull

all

less / greater / lesseq / greatereq

number

contains / notContains / startWith / endWith

text, email, phone

in

list, user, text

range

number, date

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
structure_idstringOptional

Form identifier (required unless reference=true).

Default: nullPattern: \d+
pagestringOptional

Page of the overview.

Default: 0Pattern: \d+
per_pagestringOptional

Number of result by page (Max 1000)

Default: 10Pattern: -?\d+
referencestringOptional

Fetch reference data

Default: nullPattern: true|false
updated_sincestringOptional

Results updated since this date

Default: nullPattern: \d+
user_idstringOptional

Filter by user ID

Default: null
last_updated_user_idstringOptional

Filter by last updated user ID

Default: null
items_expandedstringOptional

Get full items list or user

Default: nullPattern: true|false
expanded_typesstringOptional

set expanded items types

Default: nullPattern: [a-z,]+
show_deleted_listsstringOptional

Get list item even deleted

Default: nullPattern: true|false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body

Object where each key is a valid system field name

Responses
200

Matching submissions

application/json
server_timeinteger · int64Optional
total_countintegerOptional
total_pagesintegerOptional
post/{app_short}/submissions/search
POST /{app_short}/submissions/search HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "ANY_ADDITIONAL_PROPERTY": {
    "operator": "equal",
    "value": null
  }
}
{
  "server_time": 1,
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channels": [
        "text"
      ],
      "user_id": 1,
      "last_updated_user_id": 1,
      "assigned_user": {},
      "user": {},
      "subscribers": [
        "text"
      ],
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "settings": {},
      "task_id": "123e4567-e89b-12d3-a456-426614174000",
      "data_created_at": 1,
      "data_updated_at": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "read_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Get a submission

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Query parameters
items_expandedstringOptional

Get full items list or user

Default: nullPattern: true|false
expanded_typesstringOptional

set expanded items types

Default: nullPattern: [a-z,]+
fieldsstringOptional

Get additionnal fields

Default: nullPattern: \w+
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

The requested submission.

application/json
idstring · uuidOptional
structure_idintegerOptional

Identifier of the form.

structure_versionintegerOptional

Version of the form the submission was filled against.

channelsstring[]Optional

Broadcasts matched by the submission.

user_idintegerOptional

Owner of the submission.

last_updated_user_idintegerOptional

User who last modified the submission.

assigned_userobjectOptional

User the submission is assigned to. Present only when it is assigned.

userobjectOptional

The owner of the submission — same object shape as assigned_user. Only present when the request carries items_expanded=true; absent on the list and search endpoints regardless of that parameter.

subscribersstring[]Optional

Users subscribed to the submission.

current_statestring · uuidOptional

Workflow state the submission currently sits in.

submission_numberintegerOptional

Sequential number across the workspace.

number_in_structureintegerOptional

Sequential number within the form.

latitudenumberOptional
longitudenumberOptional
settingsobjectOptional
task_idstring · uuidOptional

Task the submission belongs to, when there is one.

data_created_atintegerOptional

Creation timestamp of the data on the server.

data_updated_atintegerOptional

Last update timestamp of the data on the server.

created_atintegerOptional
updated_atintegerOptional
deleted_atintegerOptional

Deletion timestamp. Present only when the submission has been deleted.

read_atstring · date-timeOptional

When the submission was marked as read. Present only once that has happened.

get/{app_short}/submissions/{submission_id}
GET /{app_short}/submissions/{submission_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "channels": [
    "text"
  ],
  "user_id": 1,
  "last_updated_user_id": 1,
  "assigned_user": {},
  "user": {},
  "subscribers": [
    "text"
  ],
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "settings": {},
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "data_created_at": 1,
  "data_updated_at": 1,
  "created_at": 1,
  "updated_at": 1,
  "deleted_at": 1,
  "read_at": "2026-01-01T00:00:00.000Z"
}

Update a submission

put

Replaces the submission data. On a form with a workflow, include trigger_id to advance the state. A submission sitting in an end state can no longer be modified.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Query parameters
partialstringOptional

Allow partial mode

Default: falsePattern: true|false
force_restorestringOptional

Allow mobile app to restore a deleted submission

Default: false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
created_atinteger · int64Optional

Defaults to now

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired
structure_versionintegerRequired
substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

updated_atinteger · int64Optional

Defaults to now

Responses
200

Updated submission

application/json
idstring · uuidOptional
structure_idintegerOptional

Identifier of the form.

structure_versionintegerOptional

Version of the form the submission was filled against.

channelsstring[]Optional

Broadcasts matched by the submission.

user_idintegerOptional

Owner of the submission.

last_updated_user_idintegerOptional

User who last modified the submission.

assigned_userobjectOptional

User the submission is assigned to. Present only when it is assigned.

userobjectOptional

The owner of the submission — same object shape as assigned_user. Only present when the request carries items_expanded=true; absent on the list and search endpoints regardless of that parameter.

subscribersstring[]Optional

Users subscribed to the submission.

current_statestring · uuidOptional

Workflow state the submission currently sits in.

submission_numberintegerOptional

Sequential number across the workspace.

number_in_structureintegerOptional

Sequential number within the form.

latitudenumberOptional
longitudenumberOptional
settingsobjectOptional
task_idstring · uuidOptional

Task the submission belongs to, when there is one.

data_created_atintegerOptional

Creation timestamp of the data on the server.

data_updated_atintegerOptional

Last update timestamp of the data on the server.

created_atintegerOptional
updated_atintegerOptional
deleted_atintegerOptional

Deletion timestamp. Present only when the submission has been deleted.

read_atstring · date-timeOptional

When the submission was marked as read. Present only once that has happened.

put/{app_short}/submissions/{submission_id}
PUT /{app_short}/submissions/{submission_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "created_at": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "structure_id": 1,
  "structure_version": 1,
  "substitute_user_id": 1,
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": 1
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "channels": [
    "text"
  ],
  "user_id": 1,
  "last_updated_user_id": 1,
  "assigned_user": {},
  "user": {},
  "subscribers": [
    "text"
  ],
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "settings": {},
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "data_created_at": 1,
  "data_updated_at": 1,
  "created_at": 1,
  "updated_at": 1,
  "deleted_at": 1,
  "read_at": "2026-01-01T00:00:00.000Z"
}

Delete a submission

delete
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
204

Submission deleted

No content

delete/{app_short}/submissions/{submission_id}
DELETE /{app_short}/submissions/{submission_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Partially update a submission

patch

Only the items supplied are updated; every other field is left untouched.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Query parameters
partialstringOptional

Allow partial mode

Default: falsePattern: true|false
force_restorestringOptional

Allow mobile app to restore a deleted submission

Default: false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
created_atinteger · int64Optional

Defaults to now

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired
structure_versionintegerRequired
substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

updated_atinteger · int64Optional

Defaults to now

Responses
200

Full updated submission

application/json
idstring · uuidOptional
structure_idintegerOptional

Identifier of the form.

structure_versionintegerOptional

Version of the form the submission was filled against.

channelsstring[]Optional

Broadcasts matched by the submission.

user_idintegerOptional

Owner of the submission.

last_updated_user_idintegerOptional

User who last modified the submission.

assigned_userobjectOptional

User the submission is assigned to. Present only when it is assigned.

userobjectOptional

The owner of the submission — same object shape as assigned_user. Only present when the request carries items_expanded=true; absent on the list and search endpoints regardless of that parameter.

subscribersstring[]Optional

Users subscribed to the submission.

current_statestring · uuidOptional

Workflow state the submission currently sits in.

submission_numberintegerOptional

Sequential number across the workspace.

number_in_structureintegerOptional

Sequential number within the form.

latitudenumberOptional
longitudenumberOptional
settingsobjectOptional
task_idstring · uuidOptional

Task the submission belongs to, when there is one.

data_created_atintegerOptional

Creation timestamp of the data on the server.

data_updated_atintegerOptional

Last update timestamp of the data on the server.

created_atintegerOptional
updated_atintegerOptional
deleted_atintegerOptional

Deletion timestamp. Present only when the submission has been deleted.

read_atstring · date-timeOptional

When the submission was marked as read. Present only once that has happened.

patch/{app_short}/submissions/{submission_id}
PATCH /{app_short}/submissions/{submission_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "created_at": 1,
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "structure_id": 1,
  "structure_version": 1,
  "substitute_user_id": 1,
  "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": 1
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "structure_id": 1,
  "structure_version": 1,
  "items": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "channels": [
    "text"
  ],
  "user_id": 1,
  "last_updated_user_id": 1,
  "assigned_user": {},
  "user": {},
  "subscribers": [
    "text"
  ],
  "current_state": "123e4567-e89b-12d3-a456-426614174000",
  "submission_number": 1,
  "number_in_structure": 1,
  "latitude": 1,
  "longitude": 1,
  "settings": {},
  "task_id": "123e4567-e89b-12d3-a456-426614174000",
  "data_created_at": 1,
  "data_updated_at": 1,
  "created_at": 1,
  "updated_at": 1,
  "deleted_at": 1,
  "read_at": "2026-01-01T00:00:00.000Z"
}

Create multiple submissions (async)

post

Poll callbackUrl for the status of the job.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
partialstringOptional

Allow partial mode

Default: falsePattern: true|false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Bodyobject · SubmissionInput[]
created_atinteger · int64Optional

Defaults to now

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired
structure_versionintegerRequired
substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

updated_atinteger · int64Optional

Defaults to now

Responses
200

Async job accepted

application/json
callbackUrlstringOptional

URL to poll for async job status

post/{app_short}/submissions/multiple
POST /{app_short}/submissions/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

[
  {
    "created_at": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "items": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "structure_id": 1,
    "structure_version": 1,
    "substitute_user_id": 1,
    "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": 1
  }
]
{
  "callbackUrl": "text"
}

Update multiple submissions (async)

put

Poll callbackUrl for the status of the job.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
partialstringOptional

Allow partial mode

Default: falsePattern: true|false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Bodyobject · SubmissionInput[]
created_atinteger · int64Optional

Defaults to now

idstring · uuidOptional

Auto-generated if omitted

structure_idintegerRequired
structure_versionintegerRequired
substitute_user_idintegerOptional

Sets a different user as creator/owner; authenticated user is always traced in history

trigger_idstring · uuidOptional

Workflow transition to apply (PUT/PATCH only)

updated_atinteger · int64Optional

Defaults to now

Responses
200

Async job accepted

application/json
callbackUrlstringOptional

URL to poll for async job status

put/{app_short}/submissions/multiple
PUT /{app_short}/submissions/multiple HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

[
  {
    "created_at": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "items": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "structure_id": 1,
    "structure_version": 1,
    "substitute_user_id": 1,
    "trigger_id": "123e4567-e89b-12d3-a456-426614174000",
    "updated_at": 1
  }
]
{
  "callbackUrl": "text"
}

Get submissions by identifiers

post

Each identifier can optionally carry an updated_since filter.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
Responses
200

Matching submissions

application/json
post/{app_short}/submissions/byids
POST /{app_short}/submissions/byids HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "submission_ids": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "updated_since": 1
    }
  ]
}
{
  "submissions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "structure_id": 1,
      "structure_version": 1,
      "items": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "channels": [
        "text"
      ],
      "user_id": 1,
      "last_updated_user_id": 1,
      "assigned_user": {},
      "user": {},
      "subscribers": [
        "text"
      ],
      "current_state": "123e4567-e89b-12d3-a456-426614174000",
      "submission_number": 1,
      "number_in_structure": 1,
      "latitude": 1,
      "longitude": 1,
      "settings": {},
      "task_id": "123e4567-e89b-12d3-a456-426614174000",
      "data_created_at": 1,
      "data_updated_at": 1,
      "created_at": 1,
      "updated_at": 1,
      "deleted_at": 1,
      "read_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Upload a file for a submission

post

Uploads a file to attach to an image, signature or file field. Use the returned uuid in that field.

Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Query parameters
convertToPdfstringOptional

Convert uploaded file to PDF

Default: falsePattern: true|false
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
string · binaryOptional
Responses
200

File uploaded

application/json
mime-typestringOptional
sizeintegerOptional

File size in bytes

uuidstring · uuidOptional

Reference this UUID in submission fields of type image/signature/file

post/{app_short}/submissions/upload
POST /{app_short}/submissions/upload HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "mime-type": "text",
  "size": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Upload a file with explicit submission and file identifiers

post
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequired
file_idstringRequired
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
string · binaryOptional
Responses
200

File uploaded

application/json
mime-typestringOptional
sizeintegerOptional

File size in bytes

uuidstring · uuidOptional

Reference this UUID in submission fields of type image/signature/file

post/{app_short}/submissions/upload/{submission_id}/{file_id}
POST /{app_short}/submissions/upload/{submission_id}/{file_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/octet-stream
Accept: */*
Content-Length: 8

"binary"
{
  "mime-type": "text",
  "size": 1,
  "uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Get a file attached to a submission

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
file_idstringRequired
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

Binary file content

application/octet-stream
string · binaryOptional
get/{app_short}/submissions/{submission_id}/file/{file_id}
GET /{app_short}/submissions/{submission_id}/file/{file_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
binary

Poll an async submission job

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:

OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

callback_idstringRequired
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

Job status and per-submission results

application/json
get/{app_short}/submissions/multiple/callback/{callback_id}
GET /{app_short}/submissions/multiple/callback/{callback_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "callbackDetails": {
    "errors": [
      {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      }
    ],
    "nbErrors": 1,
    "nbRecordsDone": 1,
    "nbRecordsTodo": 1,
    "nbSuccess": 1,
    "status": "Planned",
    "success": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
}

Last updated

Was this helpful?