List Forms | Close | Developer API Documentation

curl https://api.close.com/api/v1/form/ \
     -u "<CLOSE_API_KEY>:"

{
  "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
}

curl https://api.close.com/api/v1/form/ \
     -u "<CLOSE_API_KEY>:"

{
  "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

_limitintegerOptionalDefaults to 100

Number of results to return.

_skipintegerOptionalDefaults 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

has_moreboolean

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

$	curl https://api.close.com/api/v1/form/ \
>	-u "<CLOSE_API_KEY>:"

1	{
2	"data": [
3	{
4	"date_created": "2024-01-15T10:00:00+00:00",
5	"date_updated": "2024-03-01T12:30:00+00:00",
6	"field_definitions": [
7	{
8	"choices": null,
9	"id": "formfld_def456",
10	"name": "name",
11	"type": "text"
12	},
13	{
14	"choices": null,
15	"id": "formfld_def789",
16	"name": "email",
17	"type": "email"
18	},
19	{
20	"choices": [
21	{
22	"label": "Sales",
23	"value": "sales"
24	},
25	{
26	"label": "Support",
27	"value": "support"
28	}
29	],
30	"id": "formfld_defabc",
31	"name": "interest",
32	"type": "select"
33	}
34	],
35	"id": "form_abc123",
36	"is_archived": false,
37	"name": "Contact Us",
38	"organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH"
39	}
40	],
41	"has_more": false
42	}