Florm Documentation

Postman collection → OpenAPI spec →

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard, going to the developer page from the user menu and clicking Generate API token.

Endpoints

GET api/team

GET
http://florm.test
/api/team

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "http://florm.test/api/team" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
 "name": "Your team name",
}

GET api/profile

GET
http://florm.test
/api/profile

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "http://florm.test/api/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
{
 "name": "Your team name",
}

GET api/forms

GET
http://florm.test
/api/forms

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json
Example request: 
curl --request GET \
    --get "http://florm.test/api/forms" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[{
 "id": "fe21c061-5b8f-4232-b57e-eacd5936bb11",
 "name": "Form name",
}]

GET api/responses

GET
http://florm.test
/api/responses

Headers

Content-Type
Example:
application/json
Accept
Example:
application/json

URL Parameters

form_id
string

The form id of the responses you want to get.

Example request: 
curl --request GET \
    --get "http://florm.test/api/responses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
Example response:
[{
 "id": "83107a64-fbd1-4b03-ad44-b2af528a415f",
 "form_id": "21db5dc5-434a-42e0-8ec7-c08475610b1b",
 "created_at": "2023-01-01T12:00:00+00:00",
 "labels": "Bug,Feature Request",
 "team_members": "support@florm.app,hello@example.com"
 "values": {
     "first_name": "Jane",
     "last_name": "Doe",
     "email": "jane.doe@example.com"
 }
}]