List Customer Form Field Values | BigCommerce Developer Center

Returns a list of form field values for the Customer or Customer Address object.

To learn about adding and managing form fields, see Adding and Editing Fields in the Account Signup Form.

Returns a list of form field values for the Customer or Customer Address object. To learn about adding and managing form fields, see [Adding and Editing Fields in the Account Signup Form](https://support.bigcommerce.com/s/article/Editing-Form-Fields).

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Customers | modify | `store_v2_customers` | | Customers | read-only | `store_v2_customers_read_only` | | Stored Payment Instruments | modify | `store_stored_payment_instruments` | | Stored Payment Instruments | read-only | `store_stored_payment_instruments_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

pageintegerOptional

Page number (page will be ignored if you provide before or after in the request). For example page=1.

limitdoubleOptional

Items count per page. limit=50

customer_idintegerOptional

Filter by the customer ID.

address_idintegerOptional

Filter by the ID of the customer address.

field_namestringOptional

Filter by the field name.

field_typeenumOptional

Filter by the field type.

checkboxes - checkboxes field
date - date field
multiline - multiline text field
numbers - numbers only field
password - password field
radiobuttons - radio buttons field
text - text field
picklist - pick list field

Filter by the field type. * `checkboxes` - checkboxes field * `date` - date field * `multiline` - multiline text field * `numbers` - numbers only field * `password` - password field * `radiobuttons` - radio buttons field * `text` - text field * `picklist` - pick list field

afterstringOptional

The cursor reference of the last entry for the previous page. Use the end_cursor value from the last response to get the next page (end_cursor is only returned on the first page or when the request contains query parameter before or after). For example after=eyJzZXNzaW9uSWQiOjM4LCJmaWVsZElkIjo0MH0.

beforestringOptional

The cursor reference of the first entry for the next page. Use the start_cursor value from the last response to get the previous page (start_cursor is only returned on the first page or when the request contains query parameter before or after). For example before=eyJzZXNzaW9uSWQiOjgsImZpZWxkSWQiOjMxfQ.

Response

datalist of objects

metaobject

Data about the response, including pagination and collection totals. Both pagination and cursor_pagination would be returned in the first page. Only pagination would be returned when page is greater than 1. Only cursor_pagination would be returned when before or after is provided in the request.

Errors

422

Unprocessable Entity Error

OAuth scopes

UI Name	Permission	Parameter
Customers	modify	`store_v2_customers`
Customers	read-only	`store_v2_customers_read_only`
Stored Payment Instruments	modify	`store_stored_payment_instruments`
Stored Payment Instruments	read-only	`store_stored_payment_instruments_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/customers/form-field-values"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"name": "Sales Rep",
5	"value": "James Bond",
6	"customer_id": 11
7	},
8	{
9	"name": "How did you hear about us?",
10	"value": "Friend",
11	"customer_id": 11
12	},
13	{
14	"name": "What is your favorite pizza topping?",
15	"value": "Black olives",
16	"customer_id": 11
17	},
18	{
19	"name": "Sales Rep",
20	"value": "None",
21	"customer_id": 12
22	},
23	{
24	"name": "How did you hear about us?",
25	"value": "Friend",
26	"customer_id": 12
27	},
28	{
29	"name": "What is your favorite pizza topping?",
30	"value": "Mushrooms",
31	"customer_id": 12
32	},
33	{
34	"name": "Sales Rep",
35	"value": "Felix Leiter",
36	"customer_id": 13
37	},
38	{
39	"name": "How did you hear about us?",
40	"value": "Email",
41	"customer_id": 13
42	},
43	{
44	"name": "What is your favorite pizza topping?",
45	"value": "Green pepper",
46	"customer_id": 13
47	},
48	{
49	"name": "Occupation",
50	"value": "Housekeeper",
51	"customer_id": 13
52	},
53	{
54	"name": "Special Delivery Instructions",
55	"value": "Leave the package at the front door",
56	"address_id": 12
57	},
58	{
59	"name": "Sales Rep",
60	"value": "General Gogol",
61	"customer_id": 14
62	},
63	{
64	"name": "How did you hear about us?",
65	"value": "Friend",
66	"customer_id": 14
67	},
68	{
69	"name": "What is your favorite pizza topping?",
70	"value": "Extra cheese",
71	"customer_id": 14
72	},
73	{
74	"name": "Special Delivery Instructions",
75	"value": "Put the package in the mailbox",
76	"address_id": 13
77	}
78	],
79	"meta": {
80	"pagination": {
81	"total": 15,
82	"count": 15,
83	"per_page": 50,
84	"current_page": 1,
85	"total_pages": 1
86	},
87	"cursor_pagination": {
88	"count": 0,
89	"per_page": 0,
90	"start_cursor": "string",
91	"end_cursor": "string",
92	"links": {
93	"previous": "string",
94	"next": "string"
95	}
96	}
97	}
98	}

Authentication

OAuth scopes

Authentication header

Further reading

Headers

Query parameters

Response

Errors

OAuth scopes

Authentication header

Further reading