List Forms | Close | Developer API Documentation

{
  "data": [
    {
      "date_created": "2024-01-15T10:00:00+00:00",
      "date_updated": "2024-03-01T12:30:00+00:00",
      "field_definitions": [
        {
          "choices": null,
          "id": "formfld_def456",
          "name": "name",
          "type": "text"
        },
        {
          "choices": null,
          "id": "formfld_def789",
          "name": "email",
          "type": "email"
        },
        {
          "choices": [
            {
              "label": "Sales",
              "value": "sales"
            },
            {
              "label": "Support",
              "value": "support"
            }
          ],
          "id": "formfld_defabc",
          "name": "interest",
          "type": "select"
        }
      ],
      "id": "form_abc123",
      "is_archived": false,
      "name": "Contact Us",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
    }
  ],
  "has_more": false
}

List all forms and their published field definitions for your organization.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

_limitintegerOptional<=100Defaults to 100

Number of results to return.

_skipintegerOptional<=1000Defaults to 0

Number of results to skip before returning, for pagination.

is_archivedbooleanOptional

Filter by archive status.

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

datalist of objects

The results on this page.

has_moreboolean

Whether more results exist after this page.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error