The REST API

Every AltiusForms instance exposes a REST API that returns JSON. Use it from scripts, BI tools and business software that need to read or send answers.

Finding the API address

Open API & Integration in the sidebar.
The Your API endpoint block shows the base address, for example https://votre-nom.altiusforms.com/api/v1/.
Open API docs leads to the interactive documentation (Swagger UI or ReDoc), which lists every endpoint and lets you try requests. The OpenAPI schema (YAML) is available at /api/schema/.

Main resources

Resource	Use
`forms/`	forms, filterable by `category`, `access_level`, `is_active`; search by name
`submissions/`	read answers and send new ones (`GET`, `POST`)
`files/`	files attached to answers (read-only), filterable by `submission`
`uploads/`	upload a file before linking it to an answer

Answers can be filtered by form and sorted by submission date:

curl -H "Authorization: Token YOUR_TOKEN" "https://votre-nom.altiusforms.com/api/v1/submissions/?form_template=12&ordering=-date_submitted"

Sending a file

First upload the file (field file, 25 MB maximum), then reference the returned id in the answer's data:

curl -H "Authorization: Token YOUR_TOKEN" -F "file=@photo.jpg" https://votre-nom.altiusforms.com/api/v1/uploads/

Permissions

The API applies the permissions of the account used: an administrator account sees all answers, any other account only its own. Answers cannot be edited or deleted through the API.

Authentication is covered in Authentication.