# List Vendors Retrieve a paginated list of vendors with support for filtering, searching, and sorting. ## Request ### Headers ### Query Parameters ## Response ### Success (200 OK) ```json { "success": true, "data": [ { "vendorId": "vnd_a1b2c3d4e5f6g7h8", "name": "Acme Referrals", "email": "partners@acmereferrals.com", "phone": "+14155551234", "status": "active", "commissionRate": 12.5, "commissionType": "percentage", "riskLevel": "low", "payoutFrequency": "monthly", "totalReferrals": 45, "activeReferrals": 38, "totalCommissionEarned": 15230.50, "kycStatus": "verified", "createdAt": "2024-01-15T10:30:00.000Z", "updatedAt": "2024-03-20T14:15:00.000Z" }, { "vendorId": "vnd_b2c3d4e5f6g7h8i9", "name": "Global Partners Inc", "email": "ops@globalpartners.io", "phone": "+442071234567", "status": "active", "commissionRate": 10.0, "commissionType": "tiered", "riskLevel": "medium", "payoutFrequency": "weekly", "totalReferrals": 120, "activeReferrals": 95, "totalCommissionEarned": 48750.00, "kycStatus": "verified", "createdAt": "2023-11-01T08:00:00.000Z", "updatedAt": "2024-03-18T09:45:00.000Z" } ], "message": "Vendors retrieved successfully", "error": null, "meta": { "request_id": "req_xxxxx", "timestamp": "2024-03-21T10:30:00.000Z", "processing_time_ms": 85, "api_version": "v1", "endpoint": "GET /vendors", "user_type": "merchant", "pagination": { "page": 1, "limit": 20, "totalItems": 2, "totalPages": 1 } } } ``` ### Error Responses ## Examples ```bash curl -X GET "https://api.zenpayz.com/merchant/api/v1/vendors?status=active&riskLevel=low&page=1&limit=20" \ -H "Authorization: Bearer zp_test_xxxxx" \ -H "X-Timestamp: 2024-03-21T10:30:00.000Z" \ -H "X-Signature: a1b2c3d4e5f6..." \ -H "X-Secret-Salt: your_secret_salt" \ -H "Content-Type: application/json" ``` ```javascript const params = new URLSearchParams({ status: 'active', riskLevel: 'low', page: '1', limit: '20', }); const response = await fetch(`https://api.zenpayz.com/merchant/api/v1/vendors?${params}`, { method: 'GET', headers: { 'Authorization': `Bearer ${apiKey}`, 'X-Timestamp': timestamp, 'X-Signature': signature, 'X-Secret-Salt': secretSalt, 'Content-Type': 'application/json', }, }); const result = await response.json(); console.log(result.data); // Array of vendors console.log(result.meta.pagination.totalItems); // Total count ``` ```javascript const vendors = await zenpays.vendors.list({ status: 'active', riskLevel: 'low', page: 1, limit: 20, }); console.log(vendors.data); // Array of vendors console.log(vendors.meta.pagination.totalItems); // Total count ``` ## Related Endpoints - [Create Vendor](/docs/rest-api/endpoints/vendors/create-vendor) - [Get Vendor](/docs/rest-api/endpoints/vendors/get-vendor) - [Vendor Stats](/docs/rest-api/endpoints/vendors/vendor-stats)