List Customer Groups

Retrieve a list of customer groups. The customer groups can be filtered by fields such as name or `id. The customer groups can also be sorted or paginated.

Responses

🟢200OK

application/json

Bodyapplication/json

Example

{
    "count": 0,
    "offset": 0,
    "limit": 0,
    "customer_groups": [
        {
            "id": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63",
            "name": "VIP",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "deleted_at": "2019-08-24T14:15:22.123Z",
            "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

List Customer Groups

Request

Request Code Samples

Responses