Get form
curl --request GET \
--url https://app.azalt.co/api/v1/forms/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.azalt.co/api/v1/forms/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.azalt.co/api/v1/forms/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.azalt.co/api/v1/forms/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.azalt.co/api/v1/forms/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.azalt.co/api/v1/forms/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.azalt.co/api/v1/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isPublic": true,
"formSites": [
{
"id": "<string>",
"siteId": "<string>",
"year": 123,
"disabledElementIds": [
"<string>"
]
}
],
"elements": [
{
"id": "<string>",
"key": "<string>",
"label": "<string>",
"required": true,
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>",
"points": 123,
"actionText": "<string>"
}
],
"parentElementId": "<string>",
"type": "NUMBER",
"unitId": "<string>",
"period": "MONTHLY",
"order": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"activityDefinitionId": "<string>",
"distributionMode": "<string>",
"formId": "<string>",
"unitName": "<string>",
"metadata": {},
"conditions": null,
"config": null,
"schedule": {
"dataEntry": {
"dueDate": {
"type": "fixed-day",
"day": 16,
"timing": "current-period"
},
"reminders": {
"enabled": true,
"offsets": [
{
"type": "days-before",
"days": 15
}
]
}
},
"approval": {
"dueDate": {
"type": "fixed-day",
"day": 16,
"timing": "current-period"
},
"reminders": {
"enabled": true,
"offsets": [
{
"type": "days-before",
"days": 15
}
]
}
}
}
}
],
"years": [
"<string>"
],
"sites": [
"<string>"
],
"metadata": null,
"settings": null
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Form
Get form
Retrieve a complete form configuration with all elements and settings for authenticated users.
Parameters:
id: Form identifier
Response includes:
- Basic Information: Name, description, instructions, creation metadata
- Form Elements: Complete list of 11 supported element types with configurations
- Text inputs, numbers, dates, dropdowns, checkboxes, radio buttons
- File uploads, rich text, sections, calculations, lookup tables
- Conditional Logic: Element dependencies and show/hide rules
- Validation Rules: Required fields, data type constraints, custom validation
- Period Configuration: Time-based data collection settings
- Sites Association: Which sites this form is deployed to
- Submission Settings: Public access, password protection, submission limits
Element Types Supported:
- Input fields (text, number, date, email)
- Selection controls (dropdown, checkbox, radio)
- Rich content (HTML, file upload)
- Calculated fields with mathematical expressions
- Lookup tables for dynamic options
GET
/
forms
/
{id}
Get form
curl --request GET \
--url https://app.azalt.co/api/v1/forms/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.azalt.co/api/v1/forms/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.azalt.co/api/v1/forms/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.azalt.co/api/v1/forms/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.azalt.co/api/v1/forms/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.azalt.co/api/v1/forms/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.azalt.co/api/v1/forms/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"isPublic": true,
"formSites": [
{
"id": "<string>",
"siteId": "<string>",
"year": 123,
"disabledElementIds": [
"<string>"
]
}
],
"elements": [
{
"id": "<string>",
"key": "<string>",
"label": "<string>",
"required": true,
"options": [
{
"label": "<string>",
"value": "<string>",
"description": "<string>",
"points": 123,
"actionText": "<string>"
}
],
"parentElementId": "<string>",
"type": "NUMBER",
"unitId": "<string>",
"period": "MONTHLY",
"order": 123,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>",
"activityDefinitionId": "<string>",
"distributionMode": "<string>",
"formId": "<string>",
"unitName": "<string>",
"metadata": {},
"conditions": null,
"config": null,
"schedule": {
"dataEntry": {
"dueDate": {
"type": "fixed-day",
"day": 16,
"timing": "current-period"
},
"reminders": {
"enabled": true,
"offsets": [
{
"type": "days-before",
"days": 15
}
]
}
},
"approval": {
"dueDate": {
"type": "fixed-day",
"day": 16,
"timing": "current-period"
},
"reminders": {
"enabled": true,
"offsets": [
{
"type": "days-before",
"days": 15
}
]
}
}
}
}
],
"years": [
"<string>"
],
"sites": [
"<string>"
],
"metadata": null,
"settings": null
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

