Retrieve all merchandisers for the authenticated admin.
/api/integrations/crm/merchandisersStep-by-step guide to integrate merchandiser data into your CRM or website
Contact us to get your API key and secret key for accessing merchandiser data
Download our ready-to-use UI components from the UI Components page - just copy and paste!
Add the API integration code to your website or CRM system using the examples in the right sidebar
Your website will now show live merchandiser data from our system automatically
Real-time merchandiser data
Contact information and status
Geographic area assignments
Subscription and payment status
Search and filter capabilities
Display active merchandisers with their contact details and performance metrics in your CRM
Show merchandiser details, assigned areas, and subscription status for team management
Generate reports on merchandiser distribution, subscription plans, and regional coverage
This endpoint returns a list of all merchandisers associated with the authenticated admin's account. You can filter the results by payment status, limit the number of results returned, and search by name, email, or phone.
Note: All data returned is scoped to the authenticated admin. You will only see merchandisers that belong to your account.
// Using fetch API
const apiKey = 'your_api_key_here';
const secretKey = 'your_secret_key_here';
async function getMerchandisers() {
try {
const response = await fetch(
'https://your-domain.com/api/integrations/crm/merchandisers?status=active&limit=10',
{
headers: {
'X-API-Key': apiKey,
'X-Secret-Key': secretKey,
'Content-Type': 'application/json'
}
}
);
const data = await response.json();
if (data.success) {
console.log('Merchandisers:', data.data.merchandisers);
return data.data.merchandisers;
} else {
console.error('Error:', data.error);
}
} catch (error) {
console.error('Request failed:', error);
}
}
// Call the function
getMerchandisers();{
"success": true,
"data": {
"merchandisers": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"fullname": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"role": "merchandiser",
"region": "North",
"subscription_plan": "premium",
"payment_status": "active",
"assigned_area": "North Region",
"transport_mode": "Bike",
"is_active": true,
"manager": {
"id": "987fcdeb-51a2-43d7-8f9e-123456789abc",
"fullname": "Mike Johnson",
"email": "mike.johnson@example.com",
"phone": "+1987654321"
}
}
],
"pagination": {
"total": 25,
"limit": 10,
"offset": 0,
"has_more": true
}
}
}