Get Customer Groups

POST

https://client-api.dev.nudgescribe.com/v1/cg

ContentCustomer GroupsCustomer GroupCustomersCustomerGet

Retrieves all customer groups within your workspace, providing complete information about your customer segmentation structure.
Enables your application to understand and display the current customer segmentation setup, supporting UI elements like dropdowns, analytics dashboards, and customer assignment interfaces.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

🟠401Unauthorised

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://client-api.dev.nudgescribe.com/v1/cg' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workspace_id": "your-workspace-id"
}'

Response Example

200 - Example 1

[
    {
        "customer_group_id": "your-customer-group-id",
        "workspace_id": "your-workspace-id",
        "group_name": "Tier 5 Customers",
        "created_at": "2025-09-08T18:17:30.444Z",
        "updated_at": "2025-09-08T18:17:30.445Z"
    },
    {
        "customer_group_id": "your-customer-group-id",
        "workspace_id": "your-workspace-id",
        "group_name": "New Prospects",
        "created_at": "2025-09-08T18:17:30.445Z",
        "updated_at": "2025-09-08T18:17:30.446Z"
    }
]

Modified at 2025-09-12 12:53:56

Create Customer Group

Update Customer Group