Add Questionnaire
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/questionnaires \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"is_active": true,
"meta": [
"<string>"
],
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
]
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/questionnaires"
payload = {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"is_active": True,
"meta": ["<string>"],
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
]
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
handle: '<string>',
description: '<string>',
questionnaireable_type: '<string>',
questionnaireable_id: '<string>',
profile_id: '<string>',
is_active: true,
meta: ['<string>'],
questions: [
{
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
mapping_key: '<string>',
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
],
pages: [
{
title: '<string>',
description: '<string>',
image_url: '<string>',
section_header: '<string>',
sort_order: 1,
questions: [
{
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
mapping_key: '<string>',
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
]
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/questionnaires', 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://api.{tenant}.getomneo.com/api/v3/questionnaires",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'handle' => '<string>',
'description' => '<string>',
'questionnaireable_type' => '<string>',
'questionnaireable_id' => '<string>',
'profile_id' => '<string>',
'is_active' => true,
'meta' => [
'<string>'
],
'questions' => [
[
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'mapping_key' => '<string>',
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
],
'pages' => [
[
'title' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'section_header' => '<string>',
'sort_order' => 1,
'questions' => [
[
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'mapping_key' => '<string>',
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/questionnaires"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/questionnaires")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/questionnaires")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"purpose": "<string>",
"is_active": true,
"meta": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>",
"pages": [
{
"id": 123,
"questionnaire_version_id": 123,
"sort_order": 123,
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"questions": [
{
"id": 123,
"questionnaire_question_id": 123,
"questionnaire_id": "<string>",
"questionnaire_page_id": 123,
"question_id": 123,
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 123,
"is_required": true,
"visibility_condition": [
"<unknown>"
],
"visibility_dependencies": [
"<unknown>"
],
"is_active": true,
"question": {
"id": "<string>",
"handle": "<string>",
"name": "<string>",
"link_type": "<string>",
"link_target": "<string>",
"link_write_policy": "<string>"
},
"version": {
"id": "<string>",
"version": "<string>",
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": "<string>",
"validation": "<string>",
"default_value": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Questionnaire
Add Questionnaire
A POST to the /questionnaires endpoint allows your application to create a questionnaire record.
POST
/
v3
/
questionnaires
Add Questionnaire
curl --request POST \
--url https://api.{tenant}.getomneo.com/api/v3/questionnaires \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"is_active": true,
"meta": [
"<string>"
],
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": true,
"visibility_condition": [
"<string>"
],
"is_active": true
}
]
}
]
}
'import requests
url = "https://api.{tenant}.getomneo.com/api/v3/questionnaires"
payload = {
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"is_active": True,
"meta": ["<string>"],
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
],
"pages": [
{
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"sort_order": 1,
"questions": [
{
"question_id": 123,
"question_handle": "<string>",
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 1,
"is_required": True,
"visibility_condition": ["<string>"],
"is_active": True
}
]
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
handle: '<string>',
description: '<string>',
questionnaireable_type: '<string>',
questionnaireable_id: '<string>',
profile_id: '<string>',
is_active: true,
meta: ['<string>'],
questions: [
{
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
mapping_key: '<string>',
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
],
pages: [
{
title: '<string>',
description: '<string>',
image_url: '<string>',
section_header: '<string>',
sort_order: 1,
questions: [
{
question_id: 123,
question_handle: '<string>',
question_version_id: 123,
mapping_key: '<string>',
sort_order: 1,
is_required: true,
visibility_condition: ['<string>'],
is_active: true
}
]
}
]
})
};
fetch('https://api.{tenant}.getomneo.com/api/v3/questionnaires', 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://api.{tenant}.getomneo.com/api/v3/questionnaires",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'handle' => '<string>',
'description' => '<string>',
'questionnaireable_type' => '<string>',
'questionnaireable_id' => '<string>',
'profile_id' => '<string>',
'is_active' => true,
'meta' => [
'<string>'
],
'questions' => [
[
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'mapping_key' => '<string>',
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
],
'pages' => [
[
'title' => '<string>',
'description' => '<string>',
'image_url' => '<string>',
'section_header' => '<string>',
'sort_order' => 1,
'questions' => [
[
'question_id' => 123,
'question_handle' => '<string>',
'question_version_id' => 123,
'mapping_key' => '<string>',
'sort_order' => 1,
'is_required' => true,
'visibility_condition' => [
'<string>'
],
'is_active' => true
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.{tenant}.getomneo.com/api/v3/questionnaires"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.{tenant}.getomneo.com/api/v3/questionnaires")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.{tenant}.getomneo.com/api/v3/questionnaires")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"handle\": \"<string>\",\n \"description\": \"<string>\",\n \"questionnaireable_type\": \"<string>\",\n \"questionnaireable_id\": \"<string>\",\n \"profile_id\": \"<string>\",\n \"is_active\": true,\n \"meta\": [\n \"<string>\"\n ],\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ],\n \"pages\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"image_url\": \"<string>\",\n \"section_header\": \"<string>\",\n \"sort_order\": 1,\n \"questions\": [\n {\n \"question_id\": 123,\n \"question_handle\": \"<string>\",\n \"question_version_id\": 123,\n \"mapping_key\": \"<string>\",\n \"sort_order\": 1,\n \"is_required\": true,\n \"visibility_condition\": [\n \"<string>\"\n ],\n \"is_active\": true\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"name": "<string>",
"handle": "<string>",
"description": "<string>",
"questionnaireable_type": "<string>",
"questionnaireable_id": "<string>",
"profile_id": "<string>",
"purpose": "<string>",
"is_active": true,
"meta": [
"<unknown>"
],
"created_at": "<string>",
"updated_at": "<string>",
"pages": [
{
"id": 123,
"questionnaire_version_id": 123,
"sort_order": 123,
"title": "<string>",
"description": "<string>",
"image_url": "<string>",
"section_header": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"questions": [
{
"id": 123,
"questionnaire_question_id": 123,
"questionnaire_id": "<string>",
"questionnaire_page_id": 123,
"question_id": 123,
"question_version_id": 123,
"mapping_key": "<string>",
"sort_order": 123,
"is_required": true,
"visibility_condition": [
"<unknown>"
],
"visibility_dependencies": [
"<unknown>"
],
"is_active": true,
"question": {
"id": "<string>",
"handle": "<string>",
"name": "<string>",
"link_type": "<string>",
"link_target": "<string>",
"link_write_policy": "<string>"
},
"version": {
"id": "<string>",
"version": "<string>",
"label": "<string>",
"description": "<string>",
"help_text": "<string>",
"icon": "<string>",
"image_url": "<string>",
"type": "<string>",
"options": "<string>",
"validation": "<string>",
"default_value": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
}
]
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Body
application/json
Maximum string length:
255Maximum string length:
255Maximum string length:
255Maximum string length:
255Available options:
booking, general, waitlist, walk_in, pre_visit, post_visit, cancellation, profile_onboarding, interaction, survey Flat questions[]: every entry lands on the auto-created Page 1. Mutually exclusive with pages[] (validated in withValidator).
Show child attributes
Show child attributes
Nested pages[]: structured form with explicit page boundaries. Each page holds its own questions[]. Mutually exclusive with top-level questions[] (validated in withValidator).
Minimum array length:
1Show child attributes
Show child attributes
Response
Questionnaire
Show child attributes
Show child attributes
⌘I