GET api/CustomForm?formId={formId}

Retrieves specified custom form

Request Information

Parameters

NameDescriptionAdditional information
formId 
Form id

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "id": 1,
  "brand_id": 2,
  "date_created": "2025-02-23T01:37:40.4331459-05:00",
  "description": "sample string 4",
  "is_enabled": true,
  "is_primary": true,
  "is_system": true,
  "name": "sample string 8",
  "form_title": "sample string 9",
  "fields": [
    {
      "column": 1,
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "is_displayed": true,
      "is_required": true,
      "row": 4
    },
    {
      "column": 1,
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "is_displayed": true,
      "is_required": true,
      "row": 4
    },
    {
      "column": 1,
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "is_displayed": true,
      "is_required": true,
      "row": 4
    }
  ],
  "hidden_fields": [
    {
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "value": "sample string 1"
    },
    {
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "value": "sample string 1"
    },
    {
      "field": {
        "field_id": 1,
        "is_system": true,
        "name": "sample string 3"
      },
      "value": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<custom_form xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ticket.Api.Org">
  <brand_id>2</brand_id>
  <date_created>2025-02-23T01:37:40.4331459-05:00</date_created>
  <description>sample string 4</description>
  <fields>
    <custom_form_item>
      <column>1</column>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <is_displayed>true</is_displayed>
      <is_required>true</is_required>
      <row>4</row>
    </custom_form_item>
    <custom_form_item>
      <column>1</column>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <is_displayed>true</is_displayed>
      <is_required>true</is_required>
      <row>4</row>
    </custom_form_item>
    <custom_form_item>
      <column>1</column>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <is_displayed>true</is_displayed>
      <is_required>true</is_required>
      <row>4</row>
    </custom_form_item>
  </fields>
  <form_title>sample string 9</form_title>
  <hidden_fields>
    <custom_form_hidden_item>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <value>sample string 1</value>
    </custom_form_hidden_item>
    <custom_form_hidden_item>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <value>sample string 1</value>
    </custom_form_hidden_item>
    <custom_form_hidden_item>
      <field>
        <field_id>1</field_id>
        <is_system>true</is_system>
        <name>sample string 3</name>
      </field>
      <value>sample string 1</value>
    </custom_form_hidden_item>
  </hidden_fields>
  <id>1</id>
  <is_enabled>true</is_enabled>
  <is_primary>true</is_primary>
  <is_system>true</is_system>
  <name>sample string 8</name>
</custom_form>