Get a Customer Group

GET

/admin/customer-groups/{id}

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

Request

Path Params

Query Params

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "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"
        }
    }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-08 12:50:29

List Customer Groups

Delete a Customer Group