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
}
},
"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"
},
"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"
}
]
}

Get Collector

Retrieve a single collector details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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"
},
"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"
}
]
}

Update Collector

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

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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 Collector

collector_name	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_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
}
},
"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"
},
"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"
}
]
}

Patch Collector

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

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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 Collector

collector_name	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_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
}
},
"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"
},
"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"
}
]
}

Remove Collector

You can remove a single collector from the form. When you delete a collector, the collector and all its responses are permanently deleted.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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."
}

Open Collector

By default, your collector is always OPEN for response collection from the moment it is created.

When you want to stop collecting answers, it is necessary to close it.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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."
}

Close Collector

When you want to stop collecting responses and answers from being able to access your form, you can close your collector.

If you want to stop collecting answers automatically, you should enable Deadline options using update / patch the collector .

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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."
}

Merge Collector

Copies responses of the collector specified in the request body and adds to the collector specified in the resource URL. The collector specified in the request body and its responses will be deleted.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Merge Collector

collector_id

string <uuid> (Collector Id)

Collector Id

Responses

Request samples

Payload

Content type

application/json

{"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215"
}

Response samples

Content type

application/json

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

Clear Collector

Delete all the responses from a given collector.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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 Collector Respondents

There are different ways to track respondents. Before you send your collector, decide if you want to track who’s taken your form or if you want to keep responses anonymous.

Get Respondents

Returns a list of respondents of the form and the collector.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector 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",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Respondent

Retrieve a single respondent details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
collector_id required	string <uuid> (Collector Id) Collector Id
respondent_id required	string <uuid> (Respondent Id) Respondent 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",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Responses

These endpoints let you create responses directly via the API and view responses you have collected through any collector type.

Get Responses

Returns a list of responses of the form and the collector.

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_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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"
}
]
}

Create Response

Create a response 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 Response

collector_id

required

string <uuid> (Collector Id)

Collector Id

Responses

Request samples

Payload

Content type

application/json

{"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215"
}

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"
},
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Response

Retrieve a single response details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
response_id required	string <uuid> (Response Id) Response 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"
},
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Response

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

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
response_id required	string <uuid> (Response Id) Response 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 Response

collector_id

string <uuid> (Collector Id)

Collector Id

Responses

Request samples

Payload

Content type

application/json

{"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215"
}

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"
},
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Response

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

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
response_id required	string <uuid> (Response Id) Response 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 Response

collector_id

string <uuid> (Collector Id)

Collector Id

Responses

Request samples

Payload

Content type

application/json

{"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215"
}

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"
},
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Response

You can remove a single response from the form.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
response_id required	string <uuid> (Response Id) Response 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 Catalogs

Catalogs can be used to filter your forms.

Get Catalogs

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

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"
},
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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 Catalogs

Add a catalogs 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

List of Catalog Ids

catalogs

Array of strings <uuid> (Catalog Id)

Responses

Request samples

Payload

Content type

application/json

{"catalogs": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Remove Catalogs

You can remove one and more catalogs from a 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

List of Catalog Ids

catalogs

Array of strings <uuid> (Catalog Id)

Responses

Request samples

Payload

Content type

application/json

{"catalogs": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Get Catalog

Retrieve a single catalog details.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
catalog_id required	string <uuid> (Catalog Id) Catalog 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"
},
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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 Catalog

You can remove a single catalog from a form.

Authorizations:

Scopes

path Parameters

form_id required	string <uuid> (Form Id) Form Id
catalog_id required	string <uuid> (Catalog Id) Catalog 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."
}

Catalogs

Catalogs help you organize and filter your forms. You can create your own catalogs, or use the catalogs automatically created when someone shares forms with you. The My Forms catalog is your default catalog.

Get Catalogs

Returns a list of catalogs 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
}
]
}

Create Catalog

Create a catalog.

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 Catalog

catalog_name required	string Catalog Name
catalog_description	string Catalog Description
	object (Catalog Metadata) Catalog Metadata
parent_catalog_id	string <uuid> Default: null Parent Catalog Id
owner_id	string <uuid> (Owner Id) The identifier of the owner of a catalog. When owner id is passed, set the owner of a catalog using this parameter. Otherwise, the requesting user is the owner of a catalog.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"parent_catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"children": 0,
"forms": 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
}
],
"forms": [{"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"
}
]
}

Get Catalog

Retrieve a single catalog details.

Authorizations:

Scopes

path Parameters

catalog_id

required

string <uuid> (Catalog Id)

Catalog 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"parent_catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"children": 0,
"forms": 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
}
],
"forms": [{"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"
}
]
}

Update Catalog

You can update fields of a catalog after the catalog is created. The following fields can be updated any time after the catalog is created.

Available fields to update:

catalog_name
catalog_description
catalog_metadata
parent_catalog_id
app_metadata

Authorizations:

Scopes

path Parameters

catalog_id

required

string <uuid> (Catalog Id)

Catalog 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 Catalog

catalog_name	string Catalog Name
catalog_description	string Catalog Description
	object (Catalog Metadata) Catalog Metadata
parent_catalog_id	string <uuid> Default: null Parent Catalog Id
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"parent_catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"children": 0,
"forms": 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
}
],
"forms": [{"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"
}
]
}

Patch Catalog

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

Available fields to update:

catalog_name
catalog_description
catalog_metadata
parent_catalog_id
app_metadata

Authorizations:

Scopes

path Parameters

catalog_id

required

string <uuid> (Catalog Id)

Catalog 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 Catalog

catalog_name	string Catalog Name
catalog_description	string Catalog Description
	object (Catalog Metadata) Catalog Metadata
parent_catalog_id	string <uuid> Default: null Parent Catalog Id
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"parent_catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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",
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"children": 0,
"forms": 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",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
}
],
"forms": [{"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"
}
]
}

Delete Catalog

Delete a catalog. When you delete a catalog, forms inside the catalog aren't deleted. Forms will stay in your account on the My Forms (System Catalog).

Authorizations:

Scopes

path Parameters

catalog_id

required

string <uuid> (Catalog Id)

Catalog 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."
}

Contacts

If your use email collectors or sms collectors to collect responses and answers, these endpoints let you create contacts to send form invite messages to by passing a contact_id as an argument to collector respondents

Get Contacts

Returns a list of contacts 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",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
}
]
}

Create Contact

Create a contact.

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 Contact

contact_name required	string Contact Name
contact_email	string <email> Contact Email
contact_phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ Contact Phone
contact_description	string Contact Description
	object (Contact Metadata) Contact Metadata
owner_id	string <uuid> (Owner Id) The identifier of the owner of a contact. When owner id is passed, set the owner of a contact using this parameter. Otherwise, the requesting user is the owner of a contact.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
}

Get Contact

Retrieve a single contact details.

Authorizations:

Scopes

path Parameters

contact_id

required

string <uuid> (Contact Id)

Contact 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",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
}

Update Contact

You can update fields of a contact after the contact is created. The following fields can be updated any time after the contact is created.

Available fields to update:

contact_name
contact_email
contact_phone
contact_description
contact_metadata
app_metadata

Authorizations:

Scopes

path Parameters

contact_id

required

string <uuid> (Contact Id)

Contact 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 Contact

contact_name	string Contact Name
contact_email	string <email> Contact Email
contact_phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ Contact Phone
contact_description	string Contact Description
	object (Contact Metadata) Contact Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
}

Patch Contact

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

Available fields to update:

contact_name
contact_email
contact_phone
contact_description
contact_metadata
app_metadata

Authorizations:

Scopes

path Parameters

contact_id

required

string <uuid> (Contact Id)

Contact 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 Contact

contact_name	string Contact Name
contact_email	string <email> Contact Email
contact_phone	string/^\+(?:[0-9]-?){6,14}[0-9]$/ Contact Phone
contact_description	string Contact Description
	object (Contact Metadata) Contact Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
}

Delete Contact

Delete a contact.

Authorizations:

Scopes

path Parameters

contact_id

required

string <uuid> (Contact Id)

Contact 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."
}

Merge Contact

Copies information of the contact specified in the request body and merges to the contact specified in the resource URL. The contact specified in the request body and its relationships will be deleted.

Authorizations:

Scopes

path Parameters

contact_id

required

string <uuid> (Contact Id)

Contact Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Merge Contact

contact_id

string <uuid> (Contact Id)

Contact Id

Responses

Request samples

Payload

Content type

application/json

{"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598"
}

Response samples

Content type

application/json

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

Contact Groups

Groups are a named list of contacts to organize your contacts. So you can easily send form to groups of contacts you create.

Get Groups

Returns a list of contact groups 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",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"members": 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"
},
"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"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"
}
]
}
]
}

Create Group

Create a contact group.

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 Group

contact_group_name required	string Contact Group Name
contact_group_description	string Contact Group Description
	object (Contact Metadata) Contact Metadata
owner_id	string <uuid> (Owner Id) The identifier of the owner of a contact group. When owner id is passed, set the owner of a contact group using this parameter. Otherwise, the requesting user is the owner of a contact group.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"members": 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"
},
"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"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"
}
]
}

Get Group

Retrieve a single contact group details.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"members": 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"
},
"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"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"
}
]
}

Update Group

You can update fields of a contact group after the contact group is created. The following fields can be updated any time after the contact group is created.

Available fields to update:

contact_group_name
contact_group_description
contact_group_metadata
app_metadata

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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 Group

contact_group_name	string Contact Group Name
contact_group_description	string Contact Group Description
	object (Contact Metadata) Contact Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"members": 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"
},
"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"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"
}
]
}

Patch Group

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

Available fields to update:

contact_group_name
contact_group_description
contact_group_metadata
app_metadata

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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 Group

contact_group_name	string Contact Group Name
contact_group_description	string Contact Group Description
	object (Contact Metadata) Contact Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"members": 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"
},
"contacts": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"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"
}
]
}

Delete Group

Delete a contact group and members. Deleting a group does not delete the contacts.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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 Group

Creates a copy of an existing contact group.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Duplicate Group

contact_group_name	string Contact Group Name
contact_group_description	string Contact Group Description
	object (Contact Metadata) Contact Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

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

Merge Group

Copies contacts in the group specified in the request body and adds to the group specified in the resource URL. The group specified in the request body and all its contacts will be deleted.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

Merge Group

contact_id

string <uuid> (Contact Group Id)

Contact Group Id

Responses

Request samples

Payload

Content type

application/json

{"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598"
}

Response samples

Content type

application/json

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

Contact Group Members

Members are contacts assigned to the group.

Get Members

Returns a list of contacts for the group that the requesting user is permitted to view.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"contact_group_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Members

Add contacts to the group.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group 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

List of Contact Ids

contacts

Array of strings <uuid> (Contact Id)

Responses

Request samples

Payload

Content type

application/json

{"contacts": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Remove Members

You can remove one and more contacts from the group.

Authorizations:

Scopes

path Parameters

contact_group_id

required

string <uuid> (Contact Group Id)

Contact Group Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Contact Ids

contacts

Array of strings <uuid> (Contact Id)

Responses

Request samples

Payload

Content type

application/json

{"contacts": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Get Member

Retrieve a single contact details.

Authorizations:

Scopes

path Parameters

contact_group_id required	string <uuid> (Contact Group Id) Contact Group Id
contact_id required	string <uuid> (Contact Id) Contact 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",
"contact_group_id": "c74f9d10-3dff-4145-8c6d-ed6edc21ffc2",
"contact_group_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_group_name": "string",
"contact_group_description": "string",
"contact_group_metadata": { },
"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Member

You can remove a single contact from a contact group.

Authorizations:

Scopes

path Parameters

contact_group_id required	string <uuid> (Contact Group Id) Contact Group Id
contact_id required	string <uuid> (Contact Id) Contact 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."
}

Templates

Templates have questions written by our form experts to reduce bias and help you collect the data you need.

Get Templates

Returns a list of templates 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_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"
}
]
}

Create Template

Create a template.

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 Template

template_name required	string Template Name
template_description	string Template Description
	object (Template Metadata) Template Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.
categories	Array of strings <uuid> (Categories) Categories to Assign

Responses

Request samples

Payload

Content type

application/json

{"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": { }
}
],
"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"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",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"elements": 0,
"categories": 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",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Template

Retrieve a single template details.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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_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",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"elements": 0,
"categories": 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",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Template

You can update fields of a template after the template is created. The following fields can be updated any time after the template is created.

Available fields to update:

template_name
template_description
template_metadata
app_metadata

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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 Template

template_name	string Template Name
template_description	string Template Description
	object (Template Metadata) Template Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"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": { }
}
]
}

Response samples

Content type

application/json

{"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",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"elements": 0,
"categories": 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",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Template

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

Available fields to update:

template_name
template_description
template_metadata
app_metadata

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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 Template

template_name	string Template Name
template_description	string Template Description
	object (Template Metadata) Template Metadata
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"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": { }
}
]
}

Response samples

Content type

application/json

{"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",
"aggregations": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"elements": 0,
"categories": 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",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
}
],
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Template

Delete a template.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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."
}

Template Elements

The element defines the structure of the template. More information about element types.

Get Elements

Returns a list of elements of the template.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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",
"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"
},
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
},
"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 template.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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 Template 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.
	Array of objects (app_metadata) application metadata structure for customize your needs.
parent_element_id	string <uuid> Default: null Parent Element Id

Responses

Request samples

Payload

Content type

application/json

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

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"
},
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
},
"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

template_id required	string <uuid> (Template Id) Template 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",
"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"
},
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
},
"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

template_id required	string <uuid> (Template Id) Template 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 Template 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.
	Array of objects (app_metadata) application metadata structure for customize your needs.
parent_element_id	string <uuid> Default: null Parent Element Id

Responses

Request samples

Payload

Content type

application/json

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

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"
},
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
},
"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

template_id required	string <uuid> (Template Id) Template 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 Template 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.
	Array of objects (app_metadata) application metadata structure for customize your needs.
parent_element_id	string <uuid> Default: null Parent Element Id

Responses

Request samples

Payload

Content type

application/json

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

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"
},
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"parent_element_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
"element_type": "page",
"element_name": "Greeting Page",
"element_description": "Greeting Page",
"element_position": 0,
"element_metadata": {"translations": {"en": {"name": "Welcome Page",
"description": "This is welcome page."
}
}
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"parent_element_id": null,
"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"
},
"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 template.

This only removes the specified element from the template and does not affect their element data.

Authorizations:

Scopes

path Parameters

template_id required	string <uuid> (Template Id) Template 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."
}

Template Categories

Category can be used to filter form templates.

Get Categories

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

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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",
"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"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_name": "Company",
"category_description": "Company",
"category_metadata": {"template_enabled": true,
"question_enabled": true,
"image_url": "string"
},
"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"
},
"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 Categories

Add categories to the template.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template 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

List of Category Ids

categories

Array of strings <uuid> (Category Id)

Responses

Request samples

Payload

Content type

application/json

{"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Remove Categories

You can remove one and more categories from a template.

Authorizations:

Scopes

path Parameters

template_id

required

string <uuid> (Template Id)

Template Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Category Ids

categories

Array of strings <uuid> (Category Id)

Responses

Request samples

Payload

Content type

application/json

{"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Get Category

Retrieve a single category details.

Authorizations:

Scopes

path Parameters

template_id required	string <uuid> (Template Id) Template Id
category_id required	string <uuid> (Template Category Id) Category 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"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_name": "Company",
"category_description": "Company",
"category_metadata": {"template_enabled": true,
"question_enabled": true,
"image_url": "string"
},
"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"
},
"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 Category

You can remove a single category from a template.

Authorizations:

Scopes

path Parameters

template_id required	string <uuid> (Template Id) Template Id
category_id required	string <uuid> (Template Category Id) Category 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."
}

Questions

Question Bank is a library containing hundreds of questions you can add to your form in subseconds. These questions are written and certified by our very own form methodologists.

Get Questions

Returns a list of questions 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",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"categories": 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"
},
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Question

Create a question for the question bank.

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 Question

question_type required	string (Question Type) Default: "input_text" Enum: "input_text" "input_date" "input_number" "single_choice" "multiple_choice" "table" "file_upload" Question Type.
question_name required	string Question Name
question_description	string Question Description
	Input Text (object) or Input Date (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Question Metadata) Question Metadata. It depends on question type.
	Array of objects (app_metadata) application metadata structure for customize your needs.
categories	Array of strings <uuid> (Categories) Categories to Assign.

Responses

Request samples

Payload

Content type

application/json

{"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"app_metadata": [{"key": "string",
"value": { }
}
],
"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"categories": 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"
},
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Question

Retrieve a single question details.

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"categories": 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"
},
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Question

You can update fields of a question after the question is created. The following fields can be updated any time after the question is created.

Available fields to update:

question_name
question_description
question_metadata
app_metadata

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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 Question

question_name	string Question Name
question_description	string Question Description
	Input Text (object) or Input Date (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Question Metadata) Question Metadata. It depends on question type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"categories": 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"
},
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Question

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

Available fields to update:

question_name
question_description
question_metadata
app_metadata

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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 Question

question_name	string Question Name
question_description	string Question Description
	Input Text (object) or Input Date (object) or Input Number (object) or Single Choice (object) or Multiple Choice (object) or Table (object) or File Upload (object) (Question Metadata) Question Metadata. It depends on question type.
	Array of objects (app_metadata) application metadata structure for customize your needs.

Responses

Request samples

Payload

Content type

application/json

{"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"app_metadata": [{"key": "string",
"value": { }
}
]
}

Response samples

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"categories": 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"
},
"categories": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"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 Question

Delete a question. When you delete a question, the entire question and all its question categories are permanently deleted.

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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."
}

Question Categories

Question category can be used to filter questions from the question bank.

Get Categories

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

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"question_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_name": "Company",
"category_description": "Company",
"category_metadata": {"template_enabled": true,
"question_enabled": true,
"image_url": "string"
},
"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"
},
"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 Categories

Add categories to the question.

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question 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

List of Category Ids

categories

Array of strings <uuid> (Category Id)

Responses

Request samples

Payload

Content type

application/json

{"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Remove Categories

You can remove one and more categories from a question.

Authorizations:

Scopes

path Parameters

question_id

required

string <uuid> (Question Id)

Question Id

header Parameters

Authorization

required

string (bearer_authorization)

Default: Bearer {{access_token}}

Bearer {{access_token}}

Request Body schema: application/json

List of Category Ids

categories

Array of strings <uuid> (Category Id)

Responses

Request samples

Payload

Content type

application/json

{"categories": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

Content type

application/json

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

Get Category

Retrieve a single category details.

Authorizations:

Scopes

path Parameters

question_id required	string <uuid> (Question Id) Question Id
category_id required	string <uuid> (Question Category Id) Category 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",
"question_id": "827e810a-4b1a-40f6-8bc2-c3dd6fcedc25",
"question_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"question_type": "input_text",
"question_name": "What's your name?",
"question_description": "What's your name?",
"question_metadata": {"required": false,
"grading": { },
"chars": 120,
"lines": 1
},
"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"
},
"category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
"category_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category_name": "Company",
"category_description": "Company",
"category_metadata": {"template_enabled": true,
"question_enabled": true,
"image_url": "string"
},
"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"
},
"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 Category

You can remove a single category from a question.

Authorizations:

Scopes

path Parameters

question_id required	string <uuid> (Question Id) Question Id
category_id required	string <uuid> (Question Category Id) Category 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 Models

Form Models:

Form
Forms
Form Aggregation
Form Element
Form Elements
Form Logic
Form Logics
Form Collector
Form Collectors
Form Collector Respondent
Form Collector Respondents
Form Response
Form Responses
Form Catalog
Form Catalogs

Form

Resource Type: Single Resource

Fields:

id
template_id
form_type
form_name
form_description
form_metadata
app_metadata
owner_id
created_at
updated_at

Child Resources:

template_data
owner_data
aggregations
elements
logics
collectors
catalogs

id	string <uuid> (Form Id) Form Id
template_id	string <uuid> (Template Id) Template Id
	object (Template) Template
form_type	string (Form Type) Enum: "survey" "quiz" "poll" Form Type.
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.
owner_id	string <uuid> (user_id) User Id
	object (user)
	Array of objects (app_metadata) application metadata structure for customize your needs.
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (Form Aggregations) Form Aggregations
	Array of objects (Element)
	Array of objects (Logic)
	Array of objects (Collector)
	Array of objects (Response)
	Array of objects (Form Catalog)

{"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"
}
]
}

Forms

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Form Expanded) The forms in the collection.

{"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"
}
]
}
]
}

Form Aggregation

Resource Type: Single Resource

Fields:

id
form_id
elements
logics
collectors
catalogs
created_at
updated_at

Child Resources: No child resources.

id	string <uuid> (id) System generated uuid
form_id	string <uuid> (Form Id) Form Id
elements	integer Default: 0 Number of Elements
collectors	integer Default: 0 Number of Collectors
responses	integer Default: 0 Number of Responses
catalogs	integer Default: 0 Number of Catalogs
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"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"
}

Form Element

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources:

aggregations

id	string <uuid> (Element Id) Element Id
form_id	string <uuid> (Form Id) Form Id
	object (Form) Form
element_type	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	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.
	object (Element) Form Element
	Array of objects (app_metadata) application metadata structure for customize your needs.
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (Element Aggregations) Element Aggregations
	Array of objects (Element) Child Elements

{"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"
}
]
}

Form Elements

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Element Expanded) Elements in the collection.

{"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"
}
]
}
]
}

Form Logic

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources:

aggregations

id	string <uuid> (Logic Id) Logic Id
form_id	string <uuid> (Form Id) Form Id
logic_type	string (Logic Type) Value: "skip" Logic Type.
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.
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"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"
}

Form Logics

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Logic Expanded) Logics in the collection.

{"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"
}
]
}

Form Collector

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources:

aggregations

id	string <uuid> (Collector Id) Collector Id
form_id	string <uuid> (Form Id) Form Id
	object (Form) Form
collector_type	string (Collector Type) Default: "manual" Enum: "manual" "weblink" Collector Type.
collector_name	string Collector Name
collector_description	string Collector Description
	Manual (object) or Weblink (object) (Collector Metadata) Collector Metadata. It depends on collector type.
collector_status	string (Collector Status) Default: "open" Enum: "open" "closed" Collector Status.
	Array of objects (app_metadata) application metadata structure for customize your needs.
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time
	object (Collector Aggregations) Collector Aggregations
	Array of objects (Respondent) Respondents
	Array of objects (Response) Responses

{"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"
}
]
}

Form Collectors

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Collector Expanded) Collectors in the collection.

{"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"
}
]
}
]
}

Form Collector Respondent

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources:

aggregations

id	string <uuid> (Respondent Id) Respondent Id
collector_id	string <uuid> (Collector Id) Collector Id
	object (Collector) Collector
contact_id	string <uuid> (Contact Id) Contact Id
	object (Contact) Contact
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Collector Respondents

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Respondent Expanded) Respondents in the collection.

{"total_count": 0,
"count": 0,
"has_more": true,
"limit": 0,
"offset": 10,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"collector_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Response

Resource Type: Single Resource

Fields:

id
created_at
updated_at

Child Resources:

aggregations

id	string <uuid> (Response Id) Response Id
form_id	string <uuid> (Form Id) Form Id
	object (Form) Form
collector_id	string <uuid> (Collector Id) Collector Id
	object (Collector) Collector
contact_id	string <uuid> (Contact Id) Contact Id
	object (Contact) Contact
	Array of objects (app_metadata) application metadata structure for customize your needs.
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"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_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Responses

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Response Expanded) Responses in the collection.

{"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_id": "1d71b73d-897d-4e0f-85d3-9087b548c215",
"collector_data": {"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"
},
"contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",
"contact_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"contact_name": "John Doe",
"contact_email": "[email protected]",
"contact_phone": "+1-202-555-0192",
"contact_description": "string",
"contact_metadata": {"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"first_name": "John",
"last_name": "Doe"
},
"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"
},
"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 Catalog

Resource Type: Single Resource

Fields:

id
form_id
catalog_id
created_at
updated_at

Child Resources:

form_data
catalog_data

id	string <uuid> (Form Catalog Id) Form Catalog Id
form_id	string <uuid> (Form Id) Form Id
	object (Form) Form
catalog_id	string <uuid> (Catalog Id) Catalog Id
	object (Catalog) Catalog
created_by	string <uuid> (user_id) User Id
created_at	string <date-time> (created_at) Create at date and time
updated_by	string <uuid> (user_id) User Id
updated_at	string <date-time> (updated_at) Updated at date and time

{"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"
},
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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 Catalogs

Resource Type: Collection Resource

total_count	integer (Total Count) The total number of search records that match the query If you send request with query parameter ?total_count=true only. Otherwise the total_count is not included.
count	integer (Count) The number of items returned in the current range.
has_more	boolean (HasMore) Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
limit	integer (Limit) The actual paging size used by the server.
offset	integer (Offset) Default: 10 The offset value used in the current page.
	Array of objects (Form Catalog Expanded) Catalogs in the collection.

{"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"
},
"catalog_id": "de71ec92-2e85-49a4-a1c0-bcbd8d385f9e",
"catalog_data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"catalog_name": "My Forms",
"catalog_description": "My Forms (Default Catalog)",
"catalog_metadata": {"system": false
},
"parent_catalog_id": null,
"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"
},
"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"
}
]
}

category_name required	string Category Name
category_description	string Category Description
	object (Category Metadata) Category Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

category_name	string Category Name
category_description	string Category Description
	object (Category Metadata) Category Metadata.
	Array of objects (app_metadata) application metadata structure for customize your needs.

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: