Using The API

In order to use the Flow Forms you must first generate an API token.

Base URL

The API base URL follows this format:

https://your-domain.com/api/v1

Endpoints

Submissions

List Submissions POST /api/v1/submission

Returns a paginated list of submissions. The endpoint accepts filters as POST parameters.

Example Response:

{
	"data": [
		{"id": "sub_abc123",
			"status": "pending",
			"created_at": "2024-12-12T19:40:37.000000Z",
			"updated_at": "2024-12-12T19:47:14.000000Z",
			"children": [],
			"elements": [
				{
					"gid": "fa520600-e912-4e8c-820d-a9404ae1d365",
					"name": "Full Name",
					"value": "Test User",
					"type": "text",
					"files": []
				},
				{
					"gid": "742d4de9-df7d-44f1-bb28-fcae62c5d030",
					"name": "Email Address",
					"value": "[email protected]",
					"type": "email",
					"files": []
				},
				{
					"gid": "0b37fce5-4f04-fa2b-9a15-ddfd0113e8a8",
					"name": "Image Upload",
					"value": "<image url>",
					"type": "file",
					"files": [
						{
							"id": "97f71364-31c2-4b35-9bbc-e8ee08304f9a",
							"original_name": "example.JPG",
							"size": 181336,
							"updated_at": "2022-12-12T19:46:20.000000Z"
						}
					]
				}
			]
		}
	],
	"links": {
		"first": "https:\/\/your-domain.com\/api\/v1\/submission?page=1",
		"last": "https:\/\/your-domain.com\/api\/v1\/submission?page=1",
		"prev": null,
		"next": null
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 1,
		"path": "https:\/\/your-domain.com\/api\/v1\/submission",
		"per_page": 20,
		"to": 1,
		"total": 1
	}
}

Get Single Submission GET /api/v1/submission/{submission_id}

Returns details for a single submission.

Example Response:

{"id": "sub_abc123",
			"status": "pending",
			"created_at": "2024-12-12T19:40:37.000000Z",
			"updated_at": "2024-12-12T19:47:14.000000Z",
			"children": [],
			"elements": [
				{
					"gid": "fa520600-e912-4e8c-820d-a9404ae1d365",
					"name": "Full Name",
					"value": "Test User",
					"type": "text",
					"files": []
				},
				{
					"gid": "742d4de9-df7d-44f1-bb28-fcae62c5d030",
					"name": "Email Address",
					"value": "[email protected]",
					"type": "email",
					"files": []
				},
				{
					"gid": "0b37fce5-4f04-fa2b-9a15-ddfd0113e8a8",
					"name": "Image Upload",
					"value": "<image url>",
					"type": "file",
					"files": [
						{
							"id": "97f71364-31c2-4b35-9bbc-e8ee08304f9a",
							"original_name": "example.JPG",
							"size": 181336,
							"updated_at": "2022-12-12T19:46:20.000000Z"
						}
					]
				}
			]
		}

Webhooks

The API supports webhooks for real-time notifications. Flow Forms can send real-time data to another system when a specific event occurs in the flow. A POST request is sent to the configured URL. Webhooks are configured through the Flow Form interface on the flow itself. It returns a all the data from a specific submission.