Appearance
Endpoints for managing a team's form templates
List all form templates
| v1 | GET | https://id.amiqus.co/api/team/forms |
|---|---|---|
| v2 | GET | https://id.amiqus.co/api/v2/forms |
“List all form templates” endpoint has been replaced with “Forms → List all forms”
Added
data.*.instructions
Changed
data.statushas been replaced withdata.is_enabledwhere atruevalue means the form is “Live” while afalsevalue means it is in a “Draft” state.
Removed
The properties below have been removed as they are not relevant to “Form Templates” and instead refer to “Client Forms”
client_id,user_id,record_id,completed_at,progress,links,team_id
Below are examples of responses:
json
{
"data": [
{
"id": 1,
"reference": "392fc0f9-eda6-4903-beea-624c566c127b",
"name": "Form name...",
"description": "...",
"fields": [
{
"id": "1",
"type": "section",
"fields": [
"3"
]
},
{}
],
"version": 1,
"status": {
"value": true,
"label": "Live"
},
"team_id": 1,
"client_id": null,
"user_id": 4,
"record_id": null,
"completed_at": null,
"archived_at": null,
"created_at": "2019-08-19T13:20:36+00:00",
"updated_at": "2019-08-19T13:20:36+00:00",
"progress": {
"fields": 1,
"completed": 0,
"flags": 0
},
"links": {
"show": null,
"modify": null,
"export":
"https://id.amiqus.co/team/workflow/forms/392fc0f9-eda6-4903-beea-624c566c127b/ex
port"
}
}
],
"meta": {
"pagination": {
"total": 1,
"count": 1,
"per_page": 25,
"current_page": 1,
"total_pages": 1,
"links": []
}
}
}json
{
"object": "paginated_list",
"data": [
{
"object": "form_template",
"id": 45533,
"reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
"name": "New starter form",
"description": null,
"instructions": null,
"fields": [
{
"id": "1",
"type": "section",
"label": "",
"fields": [
"2"
]
},
{
"id": "2",
"type": "section",
"label": "Onboarding",
"fields": [
"3",
"4"
]
},
{
"id": "3",
"type": "text",
"label": "Job title",
"validation": [
"required"
]
},
{
"id": "4",
"type": "radio",
"label": {
"value": "Contract type",
"options": [
"Full-time",
"Part-time"
]
},
"validation": [
"required"
]
}
],
"version": 4,
"is_enabled": true,
"created_at": "2022-08-24T11:26:22Z",
"updated_at": "2022-08-24T11:26:22Z",
"archived_at": null
}
],
"total": 1,
"count": 1,
"limit": 100,
"current_page": 1,
"total_pages": 1,
"links": null
}INFO
📌 Please refer to List all forms for more information.
List all enabled form templates
| v1 | GET | https://id.amiqus.co/api/team/forms/enabled |
|---|---|---|
| v2 | GET | https://id.amiqus.co/api/v2/forms?enabled=true |
“List all enabled form templates” endpoint has been replaced with providing a query paramter to the “List all forms” endpoint
To get all enabled forms, call the new endpoint with the query parameter: ?enabled=true. It is now possible as well to return only form templates that are not enabled by using the query parameter ?enabled=false. Note you will only see form templates which are not enabled if you have permission to do so.
INFO
📌 Please refer to List all forms for more information.
Add new form template
| v1 | POST | https://id.amiqus.co/api/team/forms |
|---|---|---|
| v2 | POST | https://id.amiqus.co/api/v2/forms |
“Add new form template” endpoint has been replaced with “Forms → Create a form”
Below are the changes made to the request payload:
Added
instructionswhich is eithernullor aTipTapobject which typically contains instructions for the data subject on how the form should be completed.
Changed
statushas been replaced withis_enabledwhich takes a boolean value:truewhen the form template is enabled (live) orfalsewhen it is not enabled (draft). Defaults totrueif not provided.- The response code on successful creation has changed from
200to201
Removed
descriptionhas been removed
Below are examples of responses:
json
{
"data": [
{
"id": 4,
"reference": "88c72cfc-9644-4757-b7a5-db3edc187fc6",
"name": "Form name",
"description": "Form description",
"fields": [
{
"id": "1",
"type": "section",
"fields": [
"2",
"6"
]
},
{
"id": "2",
"type": "section",
"fields": [
"3",
"4",
"5"
],
"label": "Section 1"
},
{
"id": "3",
"type": "text",
"label": "Short answer title",
"validation": [
"required"
]
},
{
"id": "4",
"type": "textarea",
"label": "Paragraph title",
"value": null,
"validation": [
"required"
]
},
{
"id": "5",
"type": "checkbox",
"label": {
"value": "Multiple choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
},
{
"id": "6",
"type": "section",
"fields": [
"7"
],
"label": "Section 2"
},
{
"id": "7",
"type": "radio",
"label": {
"value": "Single choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
}
],
"version": 2,
"status": {
"value": true,
"label": "Live"
},
"team_id": 1,
"client_id": null,
"user_id": 4,
"record_id": null,
"completed_at": null,
"archived_at": null,
"created_at": "2019-08-19T13:04:26+00:00",
"updated_at": "2019-08-19T13:04:26+00:00",
"progress": {
"fields": 4,
"completed": 0,
"flags": 0
},
"links": {
"show": null,
"modify": null,
"export": "https://id.amiqus.com/team/workflow/forms/88c72cfc-9644-4757-b7a5-db3edc187fc6/export"
}
}
]
}json
{
"object": "paginated_list",
"data": [
{
"object": "form_template",
"id": 45533,
"reference": "9b81f60f-2165-4e2c-b748-6c3071053e66",
"name": "New starter form",
"description": null,
"instructions": null,
"fields": [
{
"id": "1",
"type": "section",
"label": "",
"fields": [
"2"
]
},
{
"id": "2",
"type": "section",
"label": "Onboarding",
"fields": [
"3",
"4"
]
},
{
"id": "3",
"type": "text",
"label": "Job title",
"validation": [
"required"
]
},
{
"id": "4",
"type": "radio",
"label": {
"value": "Contract type",
"options": [
"Full-time",
"Part-time"
]
},
"validation": [
"required"
]
}
],
"version": 4,
"is_enabled": true,
"created_at": "2022-08-24T11:26:22Z",
"updated_at": "2022-08-24T11:26:22Z",
"archived_at": null
}
]
}INFO
📌 Please refer to Create a form for more information.
Show a single form template
| v1 | GET | https://id.amiqus.co/api/team/forms/{reference} |
|---|---|---|
| v2 | GET | https://id.amiqus.co/api/v2/forms/{reference} |
“Show a single form template” endpoint has been replaced with “Forms → Retrieve a form”
Below are examples of responses:
json
{
"data": [
{
"id": 4,
"reference": "88c72cfc-9644-4757-b7a5-db3edc187fc6",
"name": "Form name",
"description": "Form description",
"fields": [
{
"id": "1",
"type": "section",
"fields": [
"2",
"6"
]
},
{
"id": "2",
"type": "section",
"fields": [
"3",
"4",
"5"
],
"label": "Section 1"
},
{
"id": "3",
"type": "text",
"label": "Short answer title",
"validation": [
"required"
]
},
{
"id": "4",
"type": "textarea",
"label": "Paragraph title",
"value": null,
"validation": [
"required"
]
},
{
"id": "5",
"type": "checkbox",
"label": {
"value": "Multiple choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
},
{
"id": "6",
"type": "section",
"fields": [
"7"
],
"label": "Section 2"
},
{
"id": "7",
"type": "radio",
"label": {
"value": "Single choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
}
],
"version": 2,
"status": {
"value": true,
"label": "Live"
},
"team_id": 1,
"client_id": null,
"user_id": 4,
"record_id": null,
"completed_at": null,
"archived_at": null,
"created_at": "2019-08-19T13:04:26+00:00",
"updated_at": "2019-08-19T13:04:26+00:00",
"progress": {
"fields": 4,
"completed": 0,
"flags": 0
},
"links": {
"show": null,
"modify": null,
"export": "https://id.amiqus.com/team/workflow/forms/88c72cfc-9644-4757-b7a5-db3edc187fc6/export"
}
}
]
}json
{
"object": "client_form",
"data": [
{
"id": 37344,
"reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
"type": "requested",
"client": 73212,
"record": 87564,
"name": "New starter form",
"description": null,
"instructions": null,
"fields": [
{
"id": "1",
"type": "section",
"label": "",
"fields": [
"2"
]
},
{
"id": "2",
"type": "section",
"label": "Onboarding",
"fields": [
"3",
"4"
]
},
{
"id": "3",
"type": "text",
"label": "Job title",
"validation": [
"required"
],
"flag": false,
"value": null
},
{
"id": "4",
"type": "radio",
"label": {
"value": "Contract type",
"options": [
"Full-time",
"Part-time"
]
},
"validation": [
"required"
],
"flag": false,
"value": null
}
],
"version": 1,
"created_at": "2022-10-11T13:41:38Z",
"updated_at": "2022-10-11T13:41:38Z",
"completed_at": null,
"archived_at": null
}
]
}INFO
📌 Please refer to Retrieve a form for more information.
Update existing form template
| v1 | PUT | https://id.amiqus.co/api/team/forms/{reference} |
|---|---|---|
| v2 | PATCH | https://id.amiqus.co/api/v2/forms/{reference} |
“Update existing form template” endpoint has been replaced with “Forms → Update a form”
Below are examples of responses:
json
{
"data": [
{
"id": 4,
"reference": "88c72cfc-9644-4757-b7a5-db3edc187fc6",
"name": "Form name",
"description": "Form description",
"fields": [
{
"id": "1",
"type": "section",
"fields": [
"2",
"6"
]
},
{
"id": "2",
"type": "section",
"fields": [
"3",
"4",
"5"
],
"label": "Section 1"
},
{
"id": "3",
"type": "text",
"label": "Short answer title",
"validation": [
"required"
]
},
{
"id": "4",
"type": "textarea",
"label": "Paragraph title",
"value": null,
"validation": [
"required"
]
},
{
"id": "5",
"type": "checkbox",
"label": {
"value": "Multiple choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
},
{
"id": "6",
"type": "section",
"fields": [
"7"
],
"label": "Section 2"
},
{
"id": "7",
"type": "radio",
"label": {
"value": "Single choice title",
"options": [
"Option 1",
"Option 2",
"Option 3"
]
},
"value": null
}
],
"version": 2,
"status": {
"value": true,
"label": "Live"
},
"team_id": 1,
"client_id": null,
"user_id": 4,
"record_id": null,
"completed_at": null,
"archived_at": null,
"created_at": "2019-08-19T13:04:26+00:00",
"updated_at": "2019-08-19T13:04:26+00:00",
"progress": {
"fields": 4,
"completed": 0,
"flags": 0
},
"links": {
"show": null,
"modify": null,
"export": "https://id.amiqus.com/team/workflow/forms/88c72cfc-9644-4757-b7a5-db3edc187fc6/export"
}
}
]
}json
{
"object": "client_form",
"data": [
{
"id": 37344,
"reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
"type": "requested",
"client": 73212,
"record": 87564,
"name": "New starter form",
"description": null,
"instructions": null,
"fields": [
{
"id": "1",
"type": "section",
"label": "",
"fields": [
"2"
]
},
{
"id": "2",
"type": "section",
"label": "Onboarding",
"fields": [
"3",
"4"
]
},
{
"id": "3",
"type": "text",
"label": "Job title",
"validation": [
"required"
],
"flag": false,
"value": null
},
{
"id": "4",
"type": "radio",
"label": {
"value": "Contract type",
"options": [
"Full-time",
"Part-time"
]
},
"validation": [
"required"
],
"flag": false,
"value": null
}
],
"version": 1,
"created_at": "2022-10-11T13:41:38Z",
"updated_at": "2022-10-11T13:41:38Z",
"completed_at": null,
"archived_at": null
}
]
}INFO
📌 Please refer to Update a form for more information.
Delete existing form template
| v1 | DELETE | https://id.amiqus.co/api/team/forms/{reference} |
|---|---|---|
| v2 | DELETE | https://id.amiqus.co/api/v2/forms/{reference} |
“Delete existing form template” endpoint has been replaced with “Forms → Delete a form”
Changed:
- The response code on successful deletion has changed from
200to204and no content is returned
Below are examples of responses:
json
{
"status": true
}json
{
}INFO
📌 Please refer to Delete a form for more information.