Get All Customer Segment

GET

/customer-segments/

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200Get All Customer Segment

application/json

Body

🟢200Get All Customer Segment

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/customer-segments/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: text/plain' \
--data-raw ''

Response Example

200 - Get All Customer Segment - Get All Customer Segment

{
    "success": true,
    "message": "Business customer segments fetched successfully!",
    "data": {
        "default": [
            {
                "type": "loyal",
                "name": "Loyal Customers",
                "icon": "",
                "description": "Customers with 3+ purchases in the last 30 days",
                "app_created": "2025-07-09T16:47:53.177+01:00",
                "count": 0
            },
            {
                "type": "high_potential",
                "name": "High Potential Customers",
                "icon": "",
                "description": "Customers with <2 purchases but in top 20% by spend (last 30 days)",
                "app_created": "2025-07-09T16:47:53.177+01:00",
                "count": 0
            },
            {
                "type": "sleeping",
                "name": "Sleeping Customers",
                "icon": "",
                "description": "Customers with no purchases in the last 6 months",
                "app_created": "2025-07-09T16:47:53.177+01:00",
                "count": 2
            },
            {
                "type": "new",
                "name": "New Customers",
                "icon": "",
                "description": "Customers whose first purchase is in the last 30 days",
                "app_created": "2025-07-09T16:47:53.177+01:00",
                "count": 0
            }
        ],
        "custom": [
            {
                "type": "custom",
                "name": "Newsletter Subscribers",
                "icon": "https://cdn.example.com/icons/newsletter.png",
                "description": "Customers subscribed to the newsletter",
                "app_created": "2025-07-08T11:36:10.357+01:00",
                "count": 0,
                "id": "6"
            },
            {
                "type": "custom",
                "name": "Birthday Club",
                "icon": "https://cdn.example.com/icons/birthday.png",
                "description": "Customers with birthdays this month",
                "app_created": "2025-07-08T11:35:58.760+01:00",
                "count": 0,
                "id": "5"
            },
            {
                "type": "custom",
                "name": "High Potential",
                "icon": "https://cdn.example.com/icons/potential.png",
                "description": "Customers with high engagement but low spend",
                "app_created": "2025-07-08T11:35:52.352+01:00",
                "count": 0,
                "id": "4"
            },
            {
                "type": "custom",
                "name": "Sleeping Customers",
                "icon": "https://cdn.example.com/icons/sleeping.png",
                "description": "Customers with no orders in the last 6 months",
                "app_created": "2025-07-08T11:35:08.113+01:00",
                "count": 0,
                "id": "3"
            },
            {
                "type": "custom",
                "name": "Newcomers",
                "icon": "https://cdn.example.com/icons/newcomer.png",
                "description": "Recently registered customers",
                "app_created": "2025-07-08T11:35:01.197+01:00",
                "count": 0,
                "id": "2"
            },
            {
                "type": "custom",
                "name": "VIP Customers",
                "icon": "https://cdn.example.com/icons/vip.png",
                "description": "High value repeat customers",
                "app_created": "2025-07-08T11:34:36.975+01:00",
                "count": 0,
                "id": "1"
            }
        ]
    }
}

Modified at 2025-09-12 10:38:41

Add Customer Segment

Get Customer Segment