Docs
Management API
Customers V3
Form Field Values

Form Field Values

Get Customer Form Field Values

GET /customers/form-field-values

Request

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.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
  • Content-Type in header with default of application/json - string
  • page in query - integer
    Page number (page will be ignored if you provide before or after in the request). For example page=1.
  • limit in query - number
    Items count per page. limit=50
  • customer_id in query - integer
    Filter by the customer ID.
  • address_id in query - integer
    Filter by the ID of the customer address.
  • field_name in query - string
    Filter by the field name.
  • field_type in query - string

    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

    Allowed: checkboxes | date | multiline | numbers | password | radiobuttons | text | picklist

  • after in query - string
    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.
  • before in query - string
    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.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/customers/form-field-values' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

Body

object | application/json

  • data    array[]

  • meta    object

    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.

Customer and Customer Address Form Fields example

{
"data": [
{
"customer_id": 11,
"name": "Sales Rep",
"value": "James Bond"
},
{
"customer_id": 11,
"name": "How did you hear about us?",
"value": "Friend"
},
{
"customer_id": 11,
"name": "What is your favorite pizza topping?",
"value": "Black olives"
},
{
"customer_id": 12,
"name": "Sales Rep",
"value": "None"
},
{
"customer_id": 12,
"name": "How did you hear about us?",
"value": "Friend"
},
{
"customer_id": 12,
"name": "What is your favorite pizza topping?",
"value": "Mushrooms"

Customer Form Fields example

{
"data": [
{
"customer_id": 11,
"name": "Sales Rep",
"value": "James Bond"
},
{
"customer_id": 11,
"name": "How did you hear about us?",
"value": "Friend"
},
{
"customer_id": 11,
"name": "What is your favorite pizza topping?",
"value": "Black olives"
}
],
"meta": {
"pagination": {
"count": 3,
"current_page": 1,
"per_page": 50,
"total": 3,
"total_pages": 1
},
"cursor_pagination": {
"count": 0,
"per_page": 0,
"start_cursor": "string",
"end_cursor": "string",

Customer Address Form Fields example

{
"data": [
{
"address_id": 12,
"name": "Special Delivery Instructions",
"value": "Leave the package at the front door"
}
],
"meta": {
"pagination": {
"count": 1,
"current_page": 1,
"per_page": 50,
"total": 1,
"total_pages": 1
},
"cursor_pagination": {
"count": 0,
"per_page": 0,
"start_cursor": "string",
"end_cursor": "string",
"links": {
"previous": "string",
"next": "string"
}
}
}
}

Upsert Customer Form Field Values (Deprecated)

PUT /customers/form-field-values

Request

This endpoint is deprecated. Use Update a Customer Address and Update Customers endpoints instead.

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

Limits

  • Limit of 10 concurrent requests.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string

Body

array | application/json
One of:

  • name    string
    required

    The form field name.
    Example: color

  • value
    required

    One of:
    Example: blue

  • customer_id    integer
    required

Example

[
{
"customer_id": 12,
"name": "Sales Rep",
"value": "Miss Moneypenny"
},
{
"customer_id": 12,
"name": "How did you hear about us?",
"value": "Other"
},
{
"customer_id": 12,
"name": "What is your favorite pizza topping?",
"value": "Mushrooms"
}
]

Response

Body

object | application/json

  • data    array[]

  • meta    object

    Response metadata.

response

{
"data": [
{
"customer_id": 12,
"name": "Sales Rep",
"value": "Miss Moneypenny"
},
{
"customer_id": 12,
"name": "How did you hear about us?",
"value": "Other"
},
{
"customer_id": 12,
"name": "What is your favorite pizza topping?",
"value": "Mushrooms"
}
],
"meta": {}
}
Did you find what you were looking for?
Update Customer ConsentGet Customer Form Field Values