Skip to main content
GET
/
forms
List forms
curl --request GET \
  --url https://api.heffl.com/api/v2/forms \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "entity": "<string>",
      "submissionCount": 123,
      "createdById": "<string>",
      "createdByName": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Query Parameters

cursor
string

Cursor for pagination. Pass the previous response meta.nextCursor value (a form ID) to fetch the next page.

pageSize
integer
default:30

Number of items to return per page (max 100)

Required range: 1 <= x <= 100

Filter forms whose title contains this text

Response

OK

data
object[]
required
meta
object
required