Customer Groups Organizing customers into segments for targeting and management
Customer groups let you segment customers into logical groups — VIPs, wholesale buyers, loyalty tiers, or any other classification that fits your business. Deleting a group does not delete the customers in it.
{ "id" : "grp_abc123xyz789" , "name" : "VIP Customers" , "description" : "High-value customers with premium benefits" , "created" : "2024-01-15T10:30:00Z" , "updated" : "2024-01-16T14:22:00Z" } Field Type Description idstring Internal Linkit ID namestring Group name (unique per organization) descriptionstring Optional description
GET /api/v1/customer-groups Parameter Type Default Description pageinteger 1 Page number limitinteger 20 Items per page
cURL JavaScript Python
curl -X GET "https://linkit.works/api/v1/customer-groups?page=1&limit=25" \ -H "Authorization: Bearer your_token_here" const response = await fetch ( 'https://linkit.works/api/v1/customer-groups?page=1&limit=25' , { headers: { 'Authorization' : 'Bearer your_token_here' } } ); const groups = await response. json (); import requests response = requests.get( 'https://linkit.works/api/v1/customer-groups' , params = { 'page' : 1 , 'limit' : 25 }, headers = { 'Authorization' : 'Bearer your_token_here' } ) groups = response.json() POST /api/v1/customer-groups { "name" : "Loyalty Program - Gold" , "description" : "Customers in the gold tier" } Field Type Constraints namestring 1–100 chars, unique per organization
Field Type Constraints descriptionstring Max 500 chars
PUT /api/v1/customer-groups/{id} DELETE /api/v1/customer-groups/{id}
Deleting a group removes the group only. Customers are not affected — they are simply no longer associated with this group.
{ "code" : 409 , "error" : "Group with same name and description already exists" , "details" : { "name" : "VIP Customers" } } { "code" : 422 , "error" : "Validation error" , "details" : "Name is required" }