Get a Customer Group

GET

/admin/customer-groups/{id}

Customer Groups

Retrieve a Customer Group by its ID. You can expand the customer group's relations or select the fields that should be returned.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{BASE_URL}}/admin/customer-groups/'

Response Example

200 - Example 1

{
    "customer_group": {
        "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
        "name": "VIP",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "deleted_at": "2019-08-24T14:15:22Z",
        "customers": [
            {}
        ],
        "price_lists": [
            {}
        ],
        "metadata": {
            "car": "white"
        }
    }
}

Request

Path Params

string

required

The ID of the Customer Group.

Query Params

expand

string

optional

Comma-separated relations that should be expanded in the returned customer group.

fields

string

optional

Comma-separated fields that should be included in the returned customer group.

Responses

🟢200OK

application/json

Body

customer_group

object (Customer Group)

required

A customer group that can be used to organize customers into groups of similar traits.

string

required

The customer group's ID

Example:

cgrp_01G8ZH853Y6TFXWPG5EYE81X63

name

string

required

The name of the customer group

Example:

VIP

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

customers

array [object]

optional

The details of the customers that belong to the customer group.

price_lists

array [object]

optional

The price lists that are associated with the customer group.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Customer Groups

Delete a Customer Group