GET
/
forms
Retrieve a list of forms
curl --request GET \
  --url https://app.formbox.app/api/v1/forms \
  --header 'api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "<string>",
      "isClosed": true,
      "submissions": 123,
      "orgId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 123
  },
  "pagination": {
    "totalPages": 123,
    "currentPage": 123,
    "nextPage": 123,
    "previousPage": 123
  }
}

Headers

​
api-key
string
required

The API key.

Query Parameters

​
search
string

Search for a form by name.

​
sort
enum<string>
default:createdAt

The field to sort the forms by. The default is createdAt, and sort order is always descending.

Available options:
createdAt,
submissions
​
page
number
default:1

The page number for pagination.

Required range: x > 0
Example:

1

​
pageSize
number
default:20

The number of items per page.

Required range: 0 < x <= 100
Example:

50

Response

200
application/json

A list of forms.

The response is of type object.