Get customer extra field

GET https://app.ecwid.com/api/v3/{storeId}/store_extrafields/customers/{extrafield_key}

Request and response example

Request:

GET /api/v3/1003/store_extrafields/customers/6r0fUGw HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
  "key": "6r0fUGw",
  "title": "Offline card ID",
  "entityTypes": [
    "CUSTOMERS"
  ],
  "type": "TEXT",
  "shownOnOrderDetails": false,
  "linkedWithCheckoutField": false,
  "createdDate": "2025-03-26 10:24:22 +0000",
  "lastModifiedDate": "2025-03-26 10:24:22 +0000"
}

Required access scopes

Your app must have the following access scopes to make this request: read_customers_extrafields

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.
extrafield_key	string	Internal key (identificator) of the customer extra field.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Response JSON

A JSON object with the following fields:

Field	Type	Description
key	string	Internal ID of the customer extra field.
title	string	Extra field visible at the checkout and in Ecwid admin.
entityTypes	string	Always CUSTOMERS for customer extra fields.
type	string	Extra field type that defines its functionality. Two values are supported for customer extra fields: text - Single-line text input. Supports placeholders and pre-defined values (default). datetime - Customizable date and time picker in the form of a calendar widget on the checkout.
shownOnOrderDetails	boolean	Defines if the extra field should be visible on the order details page in Ecwid admin.
linkedWithCheckoutField	boolean	If true, this customer extra field is linked to a certain checkout extra field.
createdDate	string	Datetime when the extra fields was created
lastModifiedDate	string	Datetime of the latest extra field change.