Search customer contacts

GET https://app.ecwid.com/api/v3/{storeId}/customers/{customerId}/contacts

Request and response example

Request:

GET /api/v3/1003/customers/177737165/contacts HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
  "items": [
    {
      "id": 113861381,
      "contact": "[email protected]",
      "type": "EMAIL",
      "default": true,
      "orderBy": 0,
      "timestamp": "2025-03-26 11:07:12 +0000"
    },
    {
      "id": 199463289,
      "contact": "+01231231231",
      "type": "PHONE",
      "default": false,
      "orderBy": 5,
      "timestamp": "2025-03-26 11:07:12 +0000"
    }
  ]
}

Required access scopes

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

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.
customerId	number	Internal customer ID.

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
items	array of objects items	Detailed information about customer contacts.

items

Field	Type	Description
id	number	Internal ID of the customer contact, for example, 113861381.
contact	string	Email or link to reach the contact. Examples: [email protected] contact for EMAIL type. https://www.facebook.com/myshop_page contact for FACEBOOK type.
handle	string	Contact identifier on social media. For example, for FACEBOOK type of contact, it's a page slug: contact field: https://www.facebook.com/myshop_page handle field: myshop_page
note	string	Store owner's notes on the contact.
type	string	Contact type. Customer can have several contacts of the same type. One of: EMAIL, PHONE, FACEBOOK, INSTAGRAM, TWITTER, YOUTUBE, TIKTOK, PINTEREST, VK, FB_MESSENGER, WHATSAPP, TELEGRAM, VIBER, URL, OTHER.
default	boolean	Defines if it's a default customer contact. Only one contact of the same type can be default.
orderBy	boolean	Sorting order for contacts on the customer details page. Starts with 0 and increments by 1.
timestamp	string	Datetime when the customer contact was created.