GET
/
v4
/
forms
List forms
curl --request GET \
  --url https://api.kit.com/v4/forms \
  --header 'X-Kit-Api-Key: <api-key>'
{
  "forms": [
    {
      "id": 3361,
      "name": "Sign up",
      "created_at": "2023-02-17T11:43:55Z",
      "type": "embed",
      "format": null,
      "embed_js": "https://kit-greetings.kit.com/f049e3d9ab/index.js",
      "embed_url": "https://kit-greetings.kit.com/f049e3d9ab",
      "archived": false,
      "uid": "f049e3d9ab"
    },
    {
      "id": 3360,
      "name": "Lead gen",
      "created_at": "2023-02-17T11:43:55Z",
      "type": "hosted",
      "format": null,
      "embed_js": "https://kit-greetings.kit.com/ae7c1adaa1/index.js",
      "embed_url": "https://kit-greetings.kit.com/ae7c1adaa1",
      "archived": false,
      "uid": "ae7c1adaa1"
    }
  ],
  "pagination": {
    "has_previous_page": false,
    "has_next_page": false,
    "start_cursor": "WzMzNjFd",
    "end_cursor": "WzMzNjBd",
    "per_page": 500
  }
}

Authorizations

​
X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

​
after
any

To fetch next page of results, use ?after=<end_cursor>

​
before
any

To fetch previous page of results, use ?before=<start_cursor>

​
include_total_count
boolean

To include the total count of records in the response, use true. For large collections, expect a slightly slower response.

​
per_page
any

Number of results per page. Default 500, maximum 1000.

​
status
enum<string>

Filter forms that have this status (active, archived, trashed, or all). Defaults to active.

Available options:
active,
archived,
trashed,
all
​
type
any

Filter forms and landing pages by type. Use embed for embedded forms. Use hosted for landing pages.

Response

200
application/json

Returns a paginated list of all forms and landing pages (embedded and hosted) for your account (including active and archived)

The response is of type object.