Forms

Retrieve form definitions and their versions

List all forms

get

Returns all available forms 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)

Query parameters

per_pageintegerOptional

Number of forms per page (default 10)

Default: 10

pageintegerOptional

Page number (0-based)

Default: 0

updated_sinceinteger · int64Optional

Return only forms updated since this UNIX timestamp

Responses

200

Paginated list of forms

application/json

total_countintegerOptional

total_pagesintegerOptional

next_pageintegerOptional

server_timeinteger · int64Optional

get/{app_short}/structures

HTTPcURLJavaScriptPython

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

200

Paginated list of forms

{
  "structures": [
    {
      "id": 1,
      "version": 1,
      "name": "text",
      "created_at": 1,
      "updated_at": 1,
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "conditions": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "cdt": "text",
          "fields": [
            "text"
          ],
          "json_format": [
            {
              "field": "text",
              "value": "text",
              "operator": "text"
            }
          ]
        }
      ],
      "fields": [
        {
          "name": "text",
          "label": "text",
          "position": 1,
          "type": "text",
          "enable": true,
          "required": true,
          "prefill": true,
          "readonly": true,
          "searchable": true
        }
      ],
      "layout": {
        "pages": [],
        "fields": []
      },
      "workflows": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "created_at": 1,
          "updated_at": 1,
          "start_state": "123e4567-e89b-12d3-a456-426614174000",
          "states": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "color": "text",
              "end": true
            }
          ],
          "transitions": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "from": "123e4567-e89b-12d3-a456-426614174000",
              "to": "123e4567-e89b-12d3-a456-426614174000",
              "label": "text"
            }
          ]
        }
      ],
      "triggers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "type": "text",
          "transition_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "text",
          "label": "text"
        }
      ]
    }
  ],
  "total_count": 1,
  "total_pages": 1,
  "next_page": 1,
  "server_time": 1,
  "workflows": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "created_at": 1,
      "updated_at": 1,
      "start_state": "123e4567-e89b-12d3-a456-426614174000",
      "states": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "color": "text",
          "end": true
        }
      ],
      "transitions": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "from": "123e4567-e89b-12d3-a456-426614174000",
          "to": "123e4567-e89b-12d3-a456-426614174000",
          "label": "text"
        }
      ]
    }
  ],
  "required": {
    "linked_list_ids": [
      1
    ],
    "structure_ids": [
      1
    ]
  }
}

Get a form

get

Returns the form at the specified version, or the latest version if omitted.

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)

idintegerRequired

Form identifier

Query parameters

versionintegerOptional

Form version number

Responses

200

Form object

application/json

server_timeinteger · int64Optional

get/{app_short}/structures/{id}

HTTPcURLJavaScriptPython

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

200

Form object

{
  "structure": {
    "id": 1,
    "version": 1,
    "name": "text",
    "created_at": 1,
    "updated_at": 1,
    "settings": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "conditions": [
      {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "cdt": "text",
        "fields": [
          "text"
        ],
        "json_format": [
          {
            "field": "text",
            "value": "text",
            "operator": "text"
          }
        ]
      }
    ],
    "fields": [
      {
        "name": "text",
        "label": "text",
        "position": 1,
        "type": "text",
        "enable": true,
        "required": true,
        "prefill": true,
        "readonly": true,
        "searchable": true
      }
    ],
    "layout": {
      "pages": [],
      "fields": []
    },
    "workflows": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "created_at": 1,
        "updated_at": 1,
        "start_state": "123e4567-e89b-12d3-a456-426614174000",
        "states": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "color": "text",
            "end": true
          }
        ],
        "transitions": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "from": "123e4567-e89b-12d3-a456-426614174000",
            "to": "123e4567-e89b-12d3-a456-426614174000",
            "label": "text"
          }
        ]
      }
    ],
    "triggers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "type": "text",
        "transition_id": "123e4567-e89b-12d3-a456-426614174000",
        "color": "text",
        "label": "text"
      }
    ]
  },
  "server_time": 1
}

Get a file attached to a form

get

Returns the file attached to a form (currently Logo field images only).

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)

idintegerRequired

file_idstring · uuidRequired

Responses

200

Image file

image/jpeg

string · binaryOptional

get/{app_short}/structures/{id}/file/{file_id}

HTTPcURLJavaScriptPython

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

200

Image file

binary