List Form Fields | BigCommerce Developer Center

import requests
url = "https://your_store.example.com/api/storefront/form-fields"
response = requests.get(url)
print(response.json())

{
  "customerAccount": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 1,
      "secret": true,
      "requirements": {
        "alpha": "[A-Za-z]",
        "description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
        "minlength": 1,
        "numeric": "[0-9]"
      },
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "shippingAddress": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 1,
      "secret": true,
      "requirements": {
        "alpha": "[A-Za-z]",
        "description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
        "minlength": 1,
        "numeric": "[0-9]"
      },
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ],
  "billingAddress": [
    {
      "id": "string",
      "name": "string",
      "custom": true,
      "label": "string",
      "required": true,
      "default": "string",
      "type": "integer",
      "fieldType": "checkbox",
      "min": "string",
      "max": "string",
      "maxLength": 1,
      "secret": true,
      "requirements": {
        "alpha": "[A-Za-z]",
        "description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
        "minlength": 1,
        "numeric": "[0-9]"
      },
      "options": {
        "helperLabel": "string",
        "items": [
          {
            "label": "string",
            "value": "string"
          }
        ]
      }
    }
  ]
}

Gets form fields.

Note

Substitute your storefront domain for yourstore.example.com.

The Send a Test Request feature is not currently supported for this endpoint.

Gets form fields. > #### Note > * Substitute your storefront domain for `yourstore.example.com`. > * The Send a Test Request feature is not currently supported for this endpoint.

Query parameters

filterlist of enumsOptional

Allowed values:

Response

Returns an object with form fields groups.

customerAccountlist of objects

List of form fields for the group

shippingAddresslist of objects

List of form fields for the group

billingAddresslist of objects

List of form fields for the group

1	{
2	"customerAccount": [
3	{
4	"id": "string",
5	"name": "string",
6	"custom": true,
7	"label": "string",
8	"required": true,
9	"default": "string",
10	"type": "integer",
11	"fieldType": "checkbox",
12	"min": "string",
13	"max": "string",
14	"maxLength": 1,
15	"secret": true,
16	"requirements": {
17	"alpha": "[A-Za-z]",
18	"description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
19	"minlength": 1,
20	"numeric": "[0-9]"
21	},
22	"options": {
23	"helperLabel": "string",
24	"items": [
25	{
26	"label": "string",
27	"value": "string"
28	}
29	]
30	}
31	}
32	],
33	"shippingAddress": [
34	{
35	"id": "string",
36	"name": "string",
37	"custom": true,
38	"label": "string",
39	"required": true,
40	"default": "string",
41	"type": "integer",
42	"fieldType": "checkbox",
43	"min": "string",
44	"max": "string",
45	"maxLength": 1,
46	"secret": true,
47	"requirements": {
48	"alpha": "[A-Za-z]",
49	"description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
50	"minlength": 1,
51	"numeric": "[0-9]"
52	},
53	"options": {
54	"helperLabel": "string",
55	"items": [
56	{
57	"label": "string",
58	"value": "string"
59	}
60	]
61	}
62	}
63	],
64	"billingAddress": [
65	{
66	"id": "string",
67	"name": "string",
68	"custom": true,
69	"label": "string",
70	"required": true,
71	"default": "string",
72	"type": "integer",
73	"fieldType": "checkbox",
74	"min": "string",
75	"max": "string",
76	"maxLength": 1,
77	"secret": true,
78	"requirements": {
79	"alpha": "[A-Za-z]",
80	"description": "Passwords must be at least 7 characters and contain both alphabetic and numeric characters.",
81	"minlength": 1,
82	"numeric": "[0-9]"
83	},
84	"options": {
85	"helperLabel": "string",
86	"items": [
87	{
88	"label": "string",
89	"value": "string"
90	}
91	]
92	}
93	}
94	]
95	}