Retrieve a Form | Close | Developer API Documentation

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

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

Retrieve a single form and its published field definitions by ID.

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.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

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

Response

Successful response

date_createddatetime

date_updateddatetime

field_definitionslist of objects

idstring

is_archivedboolean

namestring

organization_idstring

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

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

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