Skip to content

Formbird API

The Formbird API comprises a set of RESTful web services that permit you to create, update, and query Formbird documents. The API may be used to develop external services and integrate Formbird with other systems.

This document introduces the Formbird API and provides details on how to call it. The examples presented use curl to demonstrate the calls available.

Handy curl tips (Linux):

  • Use \ to span multiple lines in Linux console
  • Wrap URL in plain double quotes or plain single quotes when supplying multiple parameters (ie. when using the ampersand (&) character). Avoid using stylized quotes as these are interpreted differently. When copying/pasting commands from external sources, ensure that plain quotes are in use

Handy curl tips (Windows):

  • Use ^ to span multiple lines in Windows (Command Prompt) console
  • Wrap URL in plain double quotes when supplying multiple parameters (ie. when using the ampersand (&) character). Avoid using stylized quotes as these are interpreted differently. When copying/pasting commands from external sources, ensure that plain quotes are in use

The examples that follow use http://localhost:3000 as the target; substitute this with the URL provided to you by your system administrator, eg. https://yoursubdomain.formbird.com