​
Base URL

Formbox’s API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. The Base URL for all API endpoints is:
Terminal
https://app.formbox.app/api/v1

​
Authentication

Authentication to Formbox’s API is performed via api-key. To authenticate, you need to include the api-key header with your API key in your requests like so:
Terminal
api-key: <YOUR_API_KEY>
Learn more about how to get your API key.

​
Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:
CodeDescription
200The request was successful.
400The request was invalid or cannot be served.
401The request requires user authentication.
403The server understood the request, but refuses to authorize it.
404The requested resource could not be found.
429Too many requests.
500The server encountered an unexpected condition which prevented it from fulfilling the request.

​
Caveats

  • Formbox’s API is currently in public beta and is subject to change. However, we will do our best to keep breaking changes to a minimum.