QUICKLYSTER

API Reference

Developers can connect Quicklyster with their existing stack using our API. Access endpoints for leads, conversations, QA scores, and retention triggers.

Support Center

Authentication

All API requests require authentication using your API key in the header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your Quicklyster dashboard under Settings → API Keys

Available Endpoints

GET/api/leads

Retrieve all leads with filtering options

Parameters: limit, offset, status, created_after

POST/api/leads

Create a new lead in the system

Parameters: name, email, phone, source

GET/api/conversations

Get conversation history for analysis

Parameters: lead_id, channel, date_range

GET/api/qa-scores

Retrieve quality assurance scores

Parameters: conversation_id, agent_id, score_threshold

Code Examples

JavaScript (Node.js)

const response = await fetch('https://api.quicklyster.com/api/leads', { headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } }); const leads = await response.json();

Python

import requests headers = { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' } response = requests.get('https://api.quicklyster.com/api/leads', headers=headers) leads = response.json()

Webhooks

Set up real-time notifications for lead updates, conversation events, and QA score changes.