GET
/
v1
/
forms
cURL
curl --request GET \
  --url https://platform.thena.ai/v1/forms \
  --header 'x-api-key: <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>"
      ],
      "order": 123
    }
  ],
  "status": true,
  "message": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key

Query Parameters

​
limit
number

Maximum number of forms to return per page. Defaults to 10 if not specified.

Example:

10

​
page
number

Page number for pagination (0-based). Use 0 for first page, 1 for second page, etc. Defaults to 0 if not specified.

Example:

0

​
teamId
string

Filter forms by a specific team ID. If provided, returns forms associated with the specified team along with global forms (unless onlyTeamForms is true).

Example:

"TM123456789012"

​
onlyTeamForms
boolean

When true and teamId is provided, returns only forms specific to that team (excludes global/organization-wide forms). When false or not specified, returns both team-specific and global forms.

Example:

false

​
escalationForms
boolean

When true, returns only escalation forms. When false or not specified, returns ticket creation forms. Escalation forms are used for ticket escalation workflows.

Example:

false

Response

200
application/json

Operation successful

The response is of type object.