FormRobin Logo
API docs by Redocly

FormRobin API (1.0.0)

Download OpenAPI specification:

API Support: support@formrobin.com

RESTful API for managing forms and folders in FormRobin.

Authentication

This API uses OAuth2 authentication.

Rate Limiting

API requests are rate limited. Please refer to the response headers for current limits.

User

User information operations

Get current user

Get the authenticated user's information

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "John Doe",
  • "email": "john@example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Forms

Form management operations

List forms

Get a paginated list of forms for the authenticated user. Returns 100 items per page.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": [],
  • "links": {
    },
  • "meta": {
    }
}

Create form

Create a new form

Authorizations:
BearerAuth
Request Body schema: application/json
required
name
required
string <= 255 characters
folder_id
integer or null
data
object

Form configuration data

email_notifications_enabled
boolean
Default: true
redirect_url
string or null <uri>

URL to redirect to after form submission

webhook_url
string or null <uri>

Webhook URL to POST form submissions to

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get form

Get a specific form by ID

Authorizations:
BearerAuth
path Parameters
id
required
integer

Form ID

Responses

Response samples

Content type
application/json
{}

Update form

Update a specific form

Authorizations:
BearerAuth
path Parameters
id
required
integer

Form ID

Request Body schema: application/json
required
name
string <= 255 characters
folder_id
integer or null
data
object
email_notifications_enabled
boolean
redirect_url
string or null <uri>

URL to redirect to after form submission

webhook_url
string or null <uri>

Webhook URL to POST form submissions to

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete form

Delete a specific form

Authorizations:
BearerAuth
path Parameters
id
required
integer

Form ID

Responses

Get form sessions

Get responses/sessions for a specific form. Returns 100 items per page.

Ordering behavior:

  • When completed=true: Results ordered by completed_at DESC (most recently completed first)
  • When completed is not set: Results ordered by id DESC (most recently created first)

This ordering ensures Zapier and other polling integrations receive new records reliably.

Authorizations:
BearerAuth
path Parameters
id
required
integer

Form ID

query Parameters
completed
boolean

Filter by completion status. When true, returns only completed sessions ordered by completed_at DESC. When false or omitted, returns all sessions ordered by id DESC.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}