List Customer Group
A list of all customer groups may be obtained using this endpoint. For emphasis on specific results, you can add filters based on business code, date created and other variables.
Endpoint
GET
https://app.xtrakit.com/api/v1/customer-groups
Headers
Authorization: Bearer API_KEY
Query Parameters
Parameters
Type
Description
business_code
int
Optional
Filters customer groups by the unique business code associated with the customer group.
created_at
datetime
Optional
Start date for filtering customers records.
(format: YYYY-MM-DD H:m:s)
updated_at
date
Optional
End date for filtering customers records.
(format: YYYY-MM-DD)
Sample Requests
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://app.xtrakit.com/api/v1/customer-groups',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer API_KEY', // Replace 'API_KEY' with your actual API key
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
?>
Sample Response
{
"status": 200,
"message": "Groups found: 20",
"data": {
"groups": {
"id": 1,
"group_name": "Premium Customers",
"group_description": "Customers who have spent over $1000 and have been with the business for over a year.",
"created_at": "2024-08-04 08:23:45",
"updated_at": "2024-08-04 02:00:43"
},
...
}
}
Last updated