Form APIs (0.1.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://github.com/aircampi Terms of Service

Introduction

The Form APIs lets you programmatically collect information, or quiz people and assign a grade based on their responses.

Quick Links:

Endpoints

Form APIs Endpoints.

Models

This section contains the information about resources for Aircampi Form and their fields, and child resources.

Group of models:

Server Models
Form Models
Catalog Models
Contact Models
Template Models
Question Bank Models
Category Models

Server Health

Server Health for Form APIs

Check Health

Responses

Response samples

Content type

application/json

{"server_name": "Form APIs",
"server_version": "0.1.0",
"server_status": "Active",
"server_description": "API Server for Aircampi Form"
}

Server Settings

Server Settings for Form APIs

Get Server Settings

Get a server settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{ }

Update Server Settings

Update a server settings. Updates all fields in a settings.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

object (server_settings)

Server Settings

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Patch Server Settings

Patch a server settings. Updates one or more fields in a settings. The operation updates passed fields only.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Server Settings

object (server_settings)

Server Settings

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

Content type

application/json

{ }

Forms

You can create forms to gather information.

A form consists of elements, and you create form based on templates. You can create elements using the question bank and then add the elements to forms.

Form Types:

Survey
Quiz
Poll

Get Forms

Returns a list of forms that the requesting user is permitted to view.

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create Form

Create a form.

There are 3 ways to create a form:

Create a blank form
Create a form from templates
Duplicate an existing form

Authorizations:

Scopes

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Form

template_id	string <uuid> (Template Id) Template Id
form_type	string (Form Type) Enum: "survey" "quiz" "poll" Form Type.
form_name required	string Form Name
form_description	string Form Description
	Survey (object) or Quiz (object) or Poll (object) (Form Metadata) Form Metadata. It depends on form type.
owner_id	string <uuid> (Owner Id) The identifier of the owner of a form. When owner id is passed, set the owner of a form using this parameter. Otherwise, the requesting user is the owner of a form. You can also specify this field in a transfer form request to transfer ownership. In other contexts, it is read-only.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Form

Retrieve a single form details.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Form

You can update fields of a form after the form is created.

Available fields to update:

form_name
form_description
form_metadata
app_metadata

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Form

form_name	string Form Name
form_description	string Form Description
	Survey (object) or Quiz (object) or Poll (object) (Form Metadata) Form Metadata. It depends on form type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Form

Updates one or more fields in a form. The operation updates passed fields only.

Available fields to update:

form_name
form_description
form_metadata
app_metadata

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Form

form_name	string Form Name
form_description	string Form Description
	Survey (object) or Quiz (object) or Poll (object) (Form Metadata) Form Metadata. It depends on form type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Delete Form

Delete a form. When you delete a form, the entire form and all its responses are permanently deleted.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Duplicate Form

Duplicate a form from an existing form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Duplicate Form

form_name	string Form Name
form_description	string Form Description
	Survey (object) or Quiz (object) or Poll (object) (Form Metadata) Form Metadata. It depends on form type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"template_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_name": "Customer Feedback",
"template_description": "Customer Feedback",
"template_metadata": {"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"username": "[email protected]",
"email": "[email protected]",
"email_verified": true,
"phone": "+1-202-555-0192",
"phone_verified": true,
"nickname": "Joe",
"firstname": "Bayaraa",
"middlename": "string",
"lastname": "Basan",
"familyname": "string",
"fullname": "Bayaraa Basan",
"picture": "https://github.com/BayaraaBasan.png",
"profile": "https://github.com/BayaraaBasan",
"website": "https://twitter.com/BayaraaBasan",
"gender": "male",
"birthday": "2019-08-24",
"zoneinfo": "America/Los_Angeles",
"locale": "en_US",
"app_metadata": [{"key": "string",
"value": { }
}
],
"is_blocked": false,
"is_admin": false,
"invited_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"elements": 0,
"collectors": 0,
"responses": 0,
"catalogs": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"elements": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"logics": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"collectors": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"catalogs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Transfer Form

You can transfer ownership of the form from your account to another account. The entire form, including collectors and responses, is transferred to the new owner and removed from your account.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Transfer Form Ownership

user_id

string <uuid> (user_id)

User Id

Responses

Request samples

Payload

Content type

application/json

{"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Clear Form

Delete all the responses from an entire form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Convert Form

Convert form types to be needed.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Convert Form

form_type required	string (Form Type) Enum: "survey" "quiz" "poll" Form Type.
	Survey (object) or Quiz (object) or Poll (object) (Form Metadata) Form Metadata. It depends on form type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"form_type": "survey",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Form Elements

A single element in a form, represented by the Form element resource. Element is a repeating item which can contain a page, section, title, image, video or questions.

Element Types:

Page
Section
Title
Image
Video
Input Date
Input Text
Input Number
Single Choice
Multiple Choice
Table
File Upload
See more

Get Elements

Returns a list of elements of the form. A list of the form's elements, which can include pages, sections, questions, images, video, etc.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"element_id": "98026c2a-b90c-4843-8adc-9992613765c9",
"children": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Element

Add a element to the form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Add Element

element_type required	string (Element Type) Enum: "page" "section" "title" "image" "video" "input_date" "input_text" "input_number" "single_choice" "multiple_choice" "table" "file_upload" Element Type.
element_name required	string Element Name
element_description	string Element Description
element_position	integer <int32> Element Position
	Page (object) or Section (object) or Title (object) or Image (object) or Video (object) or Input Date (object) or Input Text (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Element Metadata) Element Metadata. It depends on element type.
parent_element_id	string <uuid> (Parent Element Id) Default: null Form structure is a hierarical relationships. An element is a parent of another element if it is one step higher in the hierarchy and closer to the root element. The root element is the highest element of a form. Page is a highest element of a form. So, there is no parent element. Section is used to divide a page. So, section element's parent can be a page only. Title, image, video, input date, input text, input number, single choice, multiple choice, table and file upload are an element located under the section only. Elements other than page must have a parent element.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"element_id": "98026c2a-b90c-4843-8adc-9992613765c9",
"children": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Get Element

Retrieve a single element details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
element_id required	string <uuid> (Element Id) Element Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"element_id": "98026c2a-b90c-4843-8adc-9992613765c9",
"children": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Update Element

You can update fields of a element after the element is added.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
element_id required	string <uuid> (Element Id) Element Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Element

element_name	string Element Name
element_description	string Element Description
element_position	integer <int32> Element Position
	Page (object) or Section (object) or Title (object) or Image (object) or Video (object) or Input Date (object) or Input Text (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Element Metadata) Element Metadata. It depends on element type.
parent_element_id	string <uuid> (Parent Element Id) Default: null Form structure is a hierarical relationships. An element is a parent of another element if it is one step higher in the hierarchy and closer to the root element. The root element is the highest element of a form. Page is a highest element of a form. So, there is no parent element. Section is used to divide a page. So, section element's parent can be a page only. Title, image, video, input date, input text, input number, single choice, multiple choice, table and file upload are an element located under the section only. Elements other than page must have a parent element.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"element_id": "98026c2a-b90c-4843-8adc-9992613765c9",
"children": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Patch Element

Updates one or more fields in a element. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
element_id required	string <uuid> (Element Id) Element Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Element

element_name	string Element Name
element_description	string Element Description
element_position	integer <int32> Element Position
	Page (object) or Section (object) or Title (object) or Image (object) or Video (object) or Input Date (object) or Input Text (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Element Metadata) Element Metadata. It depends on element type.
parent_element_id	string <uuid> (Parent Element Id) Default: null Form structure is a hierarical relationships. An element is a parent of another element if it is one step higher in the hierarchy and closer to the root element. The root element is the highest element of a form. Page is a highest element of a form. So, there is no parent element. Section is used to divide a page. So, section element's parent can be a page only. Title, image, video, input date, input text, input number, single choice, multiple choice, table and file upload are an element located under the section only. Elements other than page must have a parent element.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"element_id": "98026c2a-b90c-4843-8adc-9992613765c9",
"children": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"element_type": "page",
"element_name": "string",
"element_description": "string",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"parent_element_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Remove Element

You can remove a single element from the form. When you remove an element, the element and all its children and answers are permanently deleted.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
element_id required	string <uuid> (Element Id) Element Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Form Logics

Form Logic refers to the creation of rules that show your respondents different follow-up questions or outcomes based on how they have answered previous questions.

Get Logics

Returns a list of logics of the form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Add Logic

Add a logic to the form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Logic

logic_type required	string (Logic Type) Value: "skip" Logic Type.
logic_name required	string Logic Name
logic_description	string Logic Description
	object (Logic Metadata) Logic Metadata. It depends on logic type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Get Logic

Retrieve a single logic details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
logic_id required	string <uuid> (Logic Id) Logic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Update Logic

You can update fields of a logic after the logic is added.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
logic_id required	string <uuid> (Logic Id) Logic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Logic

logic_name	string Logic Name
logic_description	string Logic Description
	object (Logic Metadata) Logic Metadata. It depends on logic type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch Logic

Updates one or more fields in a logic. The operation updates passed fields only.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
logic_id required	string <uuid> (Logic Id) Logic Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Update Logic

logic_name	string Logic Name
logic_description	string Logic Description
	object (Logic Metadata) Logic Metadata. It depends on logic type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"logic_type": "skip",
"logic_name": "string",
"logic_description": "string",
"logic_metadata": {"skip": { }
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}

Remove Logic

You can remove a single logic from the form.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
logic_id required	string <uuid> (Logic Id) Logic Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"code": "invalid_request",
"message": "Invalid `fields` parameter."
}

Form Collectors

Collectors allow you to collect form responses with a link to your form. Many types of collectors are available through the API.

Collector Types:

Manual (Default)
Web Link

Get Collectors

Returns a list of collectors of the form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all
q	string This query parameter defines the where clause. Example: ?q=(id=497f6eca-6276-4993-bfeb-53cbbbba6f08)
sort	string This parameter sort a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. For example, ?sort=created_at asc,updated_at desc
offset	integer >= 0 Default: 0 Used to define the starting position of the item collection. If offset exceeds the item count then no items are returned.
limit	integer >= 1 Default: 10 This parameter restricts the number of items returned inside the collection. If the limit exceeds the item count then the server will only return the available items.
total_count	boolean Default: false The item collection representation will include the "estimated row count" when "?total_count=true", otherwise the total_count is not included.

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Responses

Response samples

Content type

application/json

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"form_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"form_type": "survey",
"form_name": "string",
"form_description": "string",
"form_metadata": {"welcome_page": {"enabled": true
},
"branding": {"logo_url": "/img/form-image.png",
"background_color": "blue",
"background_image": "/img/form-image.png"
},
"translation": {"enabled": false,
"languages": ["mn",
"en",
"fr",
"cn",
"ru"
]
}
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
},
"collector_status": "open",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"respondents": 0,
"responses": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
},
"respondents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"responses": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"form_id": "46af4ef5-2c18-4098-9bc5-c048fb90b843",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"app_metadata": [{"key": "string",
"value": { }
}
],
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_by": "deea00dc-b6b6-4412-a483-26ac61e1f6fe",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}
]
}

Add Collector

Add a collector to the form.

Authorizations:

Scopes

path Parameters

form_id

required

string <uuid> (Form Id)

Form Id

query Parameters

fields	string This parameter filters the resource attributes. Only the specified attributes are returned. Format: ?fields=id,name
expand	string Default: "" When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". Example: ?expand=all

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Create Collector

collector_type required	string (Collector Type) Default: "manual" Enum: "manual" "weblink" Collector Type.
collector_name required	string Collector Name
collector_description	string Collector Description
	Manual (object) or Weblink (object) (Collector Metadata) Collector Metadata. It depends on collector type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"collector_type": "manual",
"collector_name": "string",
"collector_description": "string",
"collector_metadata": {"branding": { },
"deadline": {"enabled": false,
"start_data": "2019-08-24",
"end_data": "2019-08-24"
},
"respondent": {"respondent_type": "anonymous"
},
"protection": {"enabled": false,
"passcode": null
},
"response": {"multiple_responses": true,
"editable": true,
"limits": null
}
}

Form APIs (0.1.0)

Introduction

Endpoints

General:

Forms:

Catalog:

Contacts and Contact Groups:

Form Template:

Question Bank:

Category:

Models

Server Health

Check Health

Responses

Response samples

Server Settings

Get Server Settings

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Update Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Server Settings

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Forms

Get Forms

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create Form

Authorizations:

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Get Form

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update Form

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Patch Form

Authorizations:

path Parameters

query Parameters

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete Form

Authorizations: