Get a form schema

curl --request GET \
  --url https://api.introw.io/api/v1/forms/{formId}/schema \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.introw.io/api/v1/forms/{formId}/schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "form_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "name": "Register a deal",
    "fields": [
      {
        "id": "qkzv8h2m4t6r1yc9pd3sxf70",
        "label": "Deal name",
        "isRequired": true,
        "dataType": "STRING",
        "crmObject": "DEAL",
        "crmPropertyName": "dealname"
      },
      {
        "id": "w4n7bd1jy9es2rq6uh05lka3",
        "label": "Contact email",
        "isRequired": true,
        "dataType": "EMAIL",
        "crmObject": "CONTACT",
        "crmPropertyName": "email"
      },
      {
        "id": "f6ptc93xoa1mzv8ke5rjn2y4",
        "label": "Expected deal size",
        "isRequired": false,
        "dataType": "NUMBER",
        "crmObject": "DEAL",
        "crmPropertyName": "amount"
      },
      {
        "id": "b2rk8wq5vn3ty7uc1md9zjx6",
        "label": "Deal stage",
        "isRequired": true,
        "dataType": "DROPDOWN",
        "crmObject": "DEAL",
        "crmPropertyName": "dealstage",
        "options": [
          {
            "label": "Appointment scheduled",
            "value": "appointmentscheduled"
          },
          {
            "label": "Qualified to buy",
            "value": "qualifiedtobuy"
          }
        ]
      },
      {
        "id": "m8vs4kx1zt7ry2qc9nd5jwb3",
        "label": "Partner",
        "isRequired": true,
        "dataType": "PARTNER_SELECT",
        "options": [
          {
            "label": "Acme Partners",
            "value": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8"
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Get a form schema

Returns the form’s submittable fields: the field id to use as the payload key, the label, whether the field is required, the value shape to send, and (for picklists) the allowed values. Call this before POST /api/v1/forms/{formId}/submissions instead of copying field ids out of the Introw UI by hand.

Field ids. id is the key to use in the submission’s fields map. Ids are opaque, generated identifiers (for example qkzv8h2m4t6r1yc9pd3sxf70), never human-readable names, and unique per form. They are stable: a field keeps its id across form edits.

Value shapes. dataType is the one field to branch on: it tells you what to send, whether that is a string, a number, a YYYY-MM-DD date, a picklist value, or a file URL. Fields that differ only in how the portal draws them (a single-line text box versus a text area) share a data type; only the kinds that behave differently keep their own: PARTNER_SELECT picks an Introw partner, QUOTE_SELECTOR an Introw quote, and BATCH_UPLOAD carries no value at all (it is the portal’s bulk-CSV control, so over the API you send one request per submission).

Options. options is present exactly when dataType is DROPDOWN, DROPDOWN_MULTI, or PARTNER_SELECT, and is resolved live: from the CRM picklist behind the field, the pipeline stages of the form’s own CRM automation, the organisation’s synced CRM owners, the partner audience of a partner-select field, or the builder’s preset list. Options limited by the builder are already excluded. Prefer sending value. A label is also accepted and resolved to its value on submission (case-insensitively), so a payload built from human-readable names still lands correctly in the CRM; a value matching no option is passed through untouched rather than rejected, which is what keeps unrestricted picklists working. Send DROPDOWN_MULTI values joined with ;. An empty array means the option set could not be resolved (for example the CRM property has not synced yet), which is a configuration problem to fix in Introw rather than something to work around in the payload.

Fetch this whenever the form may have changed rather than caching it indefinitely: adding a required field, or changing a picklist in the CRM, changes what a valid submission looks like.

GET

api

forms

{formId}

schema

Get a form schema

curl --request GET \
  --url https://api.introw.io/api/v1/forms/{formId}/schema \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.introw.io/api/v1/forms/{formId}/schema', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": {
    "id": "form_01HVK6Y8Z8Q7J8J8J8J8J8J8J8",
    "name": "Register a deal",
    "fields": [
      {
        "id": "qkzv8h2m4t6r1yc9pd3sxf70",
        "label": "Deal name",
        "isRequired": true,
        "dataType": "STRING",
        "crmObject": "DEAL",
        "crmPropertyName": "dealname"
      },
      {
        "id": "w4n7bd1jy9es2rq6uh05lka3",
        "label": "Contact email",
        "isRequired": true,
        "dataType": "EMAIL",
        "crmObject": "CONTACT",
        "crmPropertyName": "email"
      },
      {
        "id": "f6ptc93xoa1mzv8ke5rjn2y4",
        "label": "Expected deal size",
        "isRequired": false,
        "dataType": "NUMBER",
        "crmObject": "DEAL",
        "crmPropertyName": "amount"
      },
      {
        "id": "b2rk8wq5vn3ty7uc1md9zjx6",
        "label": "Deal stage",
        "isRequired": true,
        "dataType": "DROPDOWN",
        "crmObject": "DEAL",
        "crmPropertyName": "dealstage",
        "options": [
          {
            "label": "Appointment scheduled",
            "value": "appointmentscheduled"
          },
          {
            "label": "Qualified to buy",
            "value": "qualifiedtobuy"
          }
        ]
      },
      {
        "id": "m8vs4kx1zt7ry2qc9nd5jwb3",
        "label": "Partner",
        "isRequired": true,
        "dataType": "PARTNER_SELECT",
        "options": [
          {
            "label": "Acme Partners",
            "value": "ptn_01HVK6Y8Z8Q7J8J8J8J8J8J8J8"
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-api-key

string

header

required

Introw API key shown once when the credential is created.

Path Parameters

formId

string

required

Identifier of the form, shown in the form's share dialog and in the form URL. Form identifier, shown in the form's share dialog and in the form URL.

Minimum string length: 1

Response

Form schema was resolved.

data

object

required

Show child attributes

⌘I

INTROW API

Use cases

Partner API

Forms API

CRM API

Commission payouts API

Commission lines API

Collaboration API

Embed API

Affiliate API

Get a form schema

Authorizations

Path Parameters

Response