Skip to content

API reference

Forms

Read the forms of your workspace with the fields each one accepts, for example to build your own form or to check names before you send.

List forms

GEThttps://switchyard-ccn.modulify.website/api/v1/forms
200 OK
{
  "data": [
    {
      "id": "frm_q8w2e4r6t1y3",
      "name": "Contact",
      "description": "",
      "status": "active",
      "created_at": "2026-11-02T14:12:09.000Z",
      "updated_at": "2026-11-19T08:41:55.000Z",
      "fields": [
        { "key": "email", "label": "Email", "type": "email", "required": true, "multiple": false },
        {
          "key": "topic",
          "label": "What can we help with?",
          "type": "select",
          "required": true,
          "multiple": false,
          "options": [
            { "label": "Sales", "value": "sales" },
            { "label": "Support", "value": "support" }
          ]
        },
        { "key": "interests", "label": "Interests", "type": "multiselect", "required": false, "multiple": true, "options": [] }
      ]
    }
  ]
}
  • Only fields that collect answers are listed, so headings, text blocks and dividers are left out.
  • type is one of the types on Field types.
  • multiple is true when the field takes a list.
  • options lists the values a choice field accepts. Yes or no fields accept yes and no, and country fields any two letter ISO code, so they list no options.

Read one form

GEThttps://switchyard-ccn.modulify.website/api/v1/forms/{id}

Answers with the same shape as one item of the list, under data.

Made with Modulify