# Search customer extra fields

<mark style="color:green;">`GET`</mark> `https://app.ecwid.com/api/v3/{storeId}/store_extrafields/customers`&#x20;

<details>

<summary>Request and response example</summary>

Request:

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

Response:

```json
{
  "items": [
    {
      "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"
    }
  ]
}
```

</details>

### 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. |

### Headers

The **Authorization** header is required.

<table><thead><tr><th>Header</th><th width="252">Format</th><th>Description</th></tr></thead><tbody><tr><td>Authorization</td><td><code>Bearer secret_ab***cd</code></td><td>Access token of the application.</td></tr></tbody></table>

### Response JSON

A JSON object with the following fields:

<table><thead><tr><th>Field</th><th width="252">Type</th><th>Description</th></tr></thead><tbody><tr><td>items</td><td>array of objects <a href="#items">items</a></td><td>Detailed information about customer extra fields saved in the store settings.</td></tr></tbody></table>

#### items

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ecwid.com/api-reference/rest-api/customers/customer-extra-fields/search-customer-extra-fields.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.