Get customer group

GET https://app.ecwid.com/api/v3/{storeId}/customer_groups/{groupId}

Request and response example

Request:

GET /api/v3/1003/customer_groups/9367001 HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.com

Response:

{
  "id": 9367001,
  "name": "VIP"
}

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.
groupId	number	Internal customer group ID.

Query params

All query params are optional.

Name	Type	Description
responseFields	string	Specify the exact fields to receive in response JSON. If not specified, the response JSON will have all available fields for the entity. Example: ?responseFields=name

Example of using responseFields param:

Request

curl --location 'https://app.ecwid.com/api/v3/1003/customer_groups/0?responseFields=name' \
--header 'Authorization: Bearer secret_ab***cd'

Response

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
id	number	Unique internal ID of the customer group.
name	string	Customer group name visible to customers on the storefront.
externalReferenceId	string	External ID for syncing customer goups with other services.