List forms with the Kit API

Lists the forms and landing pages with their id, name, type and embed URL, only the active ones by default. The response has forms and pagination; while has_next_page is true, pass pagination.end_cursor as after.

Identifier
kit_list_forms

The request

POST https://connect.reportei.com/api/tools/kit_list_forms/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "embed"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
typestringNoembed returns only embedded forms and hosted only landing pages.Values: embed, hosted
statusstringNoOnly the forms in this status. The default is active.Values: active, archived, trashed, all
includestringNosubscriber_count adds the number of active subscribers who joined through each form.Values: subscriber_count
per_pageintegerNoForms per page, up to 1000. The default is 500.
afterstringNoThe pagination.end_cursor of the previous page.

Supported connections

Your customer connects their Kit account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/kit, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/kit_list_forms. It becomes your agent's tool definition with no conversion.

Other Kit tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.