Retrieve form

GET

https://api.typeform.com/forms/:form_id

GET

/forms/:form_id

curl https://api.typeform.com/forms/form_id \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "id": "string",
  "title": "string",
  "language": "en",
  "fields": [
    {
      "id": "yt6gk3s1",
      "title": "string",
      "type": "calendly",
      "ref": "string",
      "properties": {
        "description": "string",
        "choices": [
          {
            "ref": "string",
            "label": "string",
            "attachment": {
              "type": "image",
              "href": "string",
              "properties": {
                "description": "string"
              }
            }
          }
        ],
        "fields": [
          "string"
        ],
        "allow_multiple_selection": false,
        "randomize": false,
        "allow_other_choice": false,
        "vertical_alignment": false,
        "supersized": false,
        "show_labels": true,
        "alphabetical_order": false,
        "hide_marks": false,
        "button_text": "Continue",
        "steps": 1.1,
        "shape": "star",
        "labels": {
          "left": "string",
          "right": "string",
          "center": "string"
        },
        "start_at_one": false,
        "structure": "DDMMYYYY",
        "separator": "/",
        "currency": "EUR",
        "price": {
          "type": "variable",
          "value": "price"
        },
        "show_button": false,
        "default_country_code": "us"
      },
      "validations": {
        "required": false,
        "max_length": 0,
        "min_value": 0,
        "max_value": 0,
        "min_selection": 0,
        "max_selection": 0
      },
      "attachment": {
        "type": "image",
        "href": {
          "image": {
            "value": "https://images.typeform.com/images/4bcd3"
          },
          "Pexels": {
            "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
          },
          "Vimeo": {
            "value": "https://vimeo.com/245714980"
          },
          "YouTube": {
            "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
          }
        },
        "scale": 0.4,
        "properties": {
          "description": "string"
        }
      },
      "layout": {
        "type": "float",
        "placement": "left",
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0.4,
          "properties": {
            "description": "string"
          }
        },
        "viewport_overrides": {
          "small": {
            "type": "float",
            "placement": "left"
          },
          "large": {
            "type": "split",
            "placement": "right"
          }
        }
      }
    }
  ],
  "hidden": [
    "string"
  ],
  "variables": {
    "score": 0,
    "price": 1.1
  },
  "welcome_screens": [
    {
      "title": "Welcome Title",
      "ref": "nice-readable-welcome-ref",
      "properties": {
        "description": "Cool description for the welcome",
        "show_button": true,
        "button_text": "start"
      },
      "attachment": {
        "type": "image",
        "href": {
          "image": {
            "value": "https://images.typeform.com/images/4bcd3"
          },
          "Pexels": {
            "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
          },
          "Vimeo": {
            "value": "https://vimeo.com/245714980"
          },
          "YouTube": {
            "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
          }
        },
        "scale": 0.4,
        "properties": {
          "description": "string"
        }
      },
      "layout": {
        "type": "float",
        "placement": "left",
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0.4,
          "properties": {
            "description": "string"
          }
        },
        "viewport_overrides": {
          "small": {
            "type": "float",
            "placement": "left"
          },
          "large": {
            "type": "split",
            "placement": "right"
          }
        }
      }
    }
  ],
  "thankyou_screens": [
    {
      "title": "Thank you Title",
      "ref": "nice-readable-thank-you-ref",
      "type": "thankyou_screen",
      "properties": {
        "show_button": true,
        "button_text": "start",
        "button_mode": "redirect",
        "redirect_url": "https://www.typeform.com",
        "share_icons": false
      },
      "attachment": {
        "type": "image",
        "href": {
          "image": {
            "value": "https://images.typeform.com/images/4bcd3"
          },
          "Pexels": {
            "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
          },
          "Vimeo": {
            "value": "https://vimeo.com/245714980"
          },
          "YouTube": {
            "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
          }
        },
        "scale": 0.4,
        "properties": {
          "description": "string"
        }
      },
      "layout": {
        "type": "float",
        "placement": "left",
        "attachment": {
          "type": "image",
          "href": {
            "image": {
              "value": "https://images.typeform.com/images/4bcd3"
            },
            "Pexels": {
              "value": "https://www.pexels.com/video/people-traveling-in-the-desert-1739011"
            },
            "Vimeo": {
              "value": "https://vimeo.com/245714980"
            },
            "YouTube": {
              "value": "https://www.youtube.com/watch?v=cGk3tZIIpXE"
            }
          },
          "scale": 0.4,
          "properties": {
            "description": "string"
          }
        },
        "viewport_overrides": {
          "small": {
            "type": "float",
            "placement": "left"
          },
          "large": {
            "type": "split",
            "placement": "right"
          }
        }
      }
    }
  ],
  "logic": [
    {
      "type": "field",
      "actions": [
        {
          "action": "jump",
          "details": {
            "to": {
              "type": "field",
              "value": "string"
            },
            "target": {
              "type": "variable",
              "value": "string"
            },
            "value": {
              "type": "constant",
              "value": 1.1
            }
          },
          "condition": {
            "op": "begins_with",
            "vars": [
              {
                "type": "field",
                "value": {}
              }
            ]
          }
        }
      ],
      "ref": "string"
    }
  ],
  "theme": {
    "href": "https://api.typeform.com/themes/Fs24as"
  },
  "workspace": {
    "href": "https://api.typeform.com/workspaces/Aw33bz"
  },
  "_links": {
    "display": "https://subdomain.typeform.com/to/abc123"
  },
  "settings": {
    "language": "en",
    "is_public": true,
    "autocomplete_progress": true,
    "progress_bar": "proportion",
    "show_progress_bar": true,
    "show_typeform_branding": true,
    "show_time_to_complete": true,
    "show_number_of_submissions": false,
    "show_cookie_consent": false,
    "show_question_number": true,
    "show_key_hint_on_choices": true,
    "hide_navigation": false,
    "meta": {
      "title": "string",
      "allow_indexing": true,
      "description": "string",
      "image": {
        "href": "string"
      }
    },
    "redirect_after_submit_url": "string",
    "google_analytics": "string",
    "facebook_pixel": "string",
    "google_tag_manager": "string",
    "milestones": [
      {
        "field_ref": "string",
        "status": "active",
        "reason": "wrong_position"
      }
    ]
  },
  "cui_settings": {
    "avatar": "https://images.typeform.com/images/4bcd3",
    "is_typing_emulation_disabled": true,
    "typing_emulation_speed": "fast"
  }
}

Retrieves a form by the given form_id. Includes any theme and images attached to the form as references.

Details about the fields and elements for this endpoint are available in the Create Form description.

Authentication

AuthorizationBearer

Bearer token authentication. Tokens can be generated from the user account. Privileges needed may vary.

Authorizationstring

A string representation of JWT containing at least two parameters:

ctx.user_id — user’s id

ctx.account_id — user’s default account id ctx.account_uid — user’s default account uid The usage of account_(u)id from JWT is discouraged, user can have access to multiple accounts, every endpoint has to be account aware if it’s needed.

This JWT must be signed by the appropriate authority.

Path parameters

form_idanyRequired

Unique ID for the form. Find in your form URL. For example, in the URL “https://mysite.typeform.com/to/u6nXL7” the form_id is u6nXL7.

Response

idstringOptional

titlestringOptional

languagestringOptionalDefaults to en

fieldslist of objectsOptional

hiddenlist of stringsOptional

variablesobjectOptional

welcome_screenslist of objectsOptional

thankyou_screenslist of objectsOptional

logiclist of objectsOptional

themeobjectOptional

workspaceobjectOptional

_linksobjectOptional

settingsobjectOptional

cui_settingsobjectOptional