Forms
Get forms by IDs
Introduction
- API Reference
- Platform
- Platform APIs
- Login & sign up
- Organizations
- SLA duration
- Users
- Teams
- Tickets
- Comments & reactions
- Custom fields
- Forms
- Draft tickets
- Accounts & contacts
- Custom objects
- Workflows
- SLA
- Storage
- Notifications
Forms
Get forms by IDs
GET
/
v1
/
forms
/
fetchByIds
curl --request GET \
--url https://platform.thena.ai/v1/forms/fetchByIds \
--header 'Authorization: Bearer <token>' \
--header 'x-org-id: <api-key>'
{
"data": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"channels": [
"<string>"
]
}
],
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}
Authorizations
Enter JWT bearer token
Enter organization ID
Query Parameters
Response
200
application/json
Operation successful
The field
Indicates if the field is editable by customer
The default value
Indicates if the field is mandatory on creation
Indicates if the field is mandatory on close
Indicates if the field is visible to customer
The ID of the trigger field
The value of the trigger field
The type of the condition
Indicates if the form is for vendor
Indicates if the form is for user
The ID of the team
curl --request GET \
--url https://platform.thena.ai/v1/forms/fetchByIds \
--header 'Authorization: Bearer <token>' \
--header 'x-org-id: <api-key>'
{
"data": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"fields": [
{
"field": "<string>",
"defaultValue": {},
"mandatoryOnCreation": true,
"mandatoryOnClose": true,
"visibleToCustomer": true,
"editableByCustomer": true
}
],
"conditions": [
{
"triggerFieldId": "<string>",
"triggerFieldValue": {},
"conditionType": "<string>",
"targetFields": [
{
"id": "<string>",
"type": "<string>",
"value": {},
"options": [
{}
]
}
],
"forVendor": true,
"forUser": true,
"teamId": "<string>"
}
],
"version": 123,
"isActive": true,
"default": true,
"channels": [
"<string>"
]
}
],
"status": true,
"message": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
}