API v1

Your data, in your tools

Everything your agents generate —leads, conversations, appointments and conversions— available to your dashboard, your CRM and your data team.

Access is provisioned per integration. Get in touch and we'll issue test credentials along with the full technical documentation.

See the technical reference

What you can pull

Available capabilities

Each capability takes filters and returns structured data. No artificial export limits.

Leads

Read and create leads, with their campaign origin already resolved.

Takes

search
temperature
status
source
campaign
channel
ad
date range
changed since
sort
pagination

Returns

name
phone
email
temperature
status
source
attribution
contact attempts
last contact
opt-out
dates

Conversations

WhatsApp and voice calls unified into a single history per lead.

Takes

channel
status
outcome
lead
agent
campaign
date range
pagination

Returns

channel
status
outcome
closing notes
duration
messages
recording
transcript
lead
agent

Appointments

Everything your agents booked, with the context that produced it.

Takes

status
lead
agent
assignee
date range
campaign

Returns

date and time
duration
status
assignee
notes
source conversation
lead

Interaction history

Each lead's timeline, touchpoint by touchpoint.

Takes

lead
interaction type
date range

Returns

interaction type
exact moment
actor
associated campaign
related call or link

Campaign attribution

Which campaign and ad each lead came from, even when they arrived via WhatsApp.

Takes

lead
date range
attribution model

Returns

source
medium
campaign
content
term
click identifier
ad
landing page
referrer
first and last touch

Conversions

Closed sales and how they were credited to the campaign that produced them.

Takes

event type
lead or phone
amount
currency
product
external identifier
date range

Returns

amount
currency
product
credited campaign
attribution model
within window
conversion date

Aggregate metrics

The full funnel already computed, ready to chart without rebuilding it by hand.

Takes

date range
grouping
attribution model

Returns

leads
conversations started
conversations engaged
qualified leads
appointments booked
appointments completed
handoffs
conversions
attributed revenue
unattributed leads

Agents

Each agent's configuration, so you can label metrics by who produced them.

Takes

active state
channel
pagination

Returns

name
goal
goal description
channels
timezone
state

Real time

Notifications the moment they happen

Instead of polling the API every minute, Kelpi tells your system as soon as something happens.

New leadA lead arrives through any channel, with its campaign already resolved.
Lead updatedAny field on the lead changes, including its temperature.
Lead qualifiedThe agent marks it ready for a salesperson. Your MQL trigger.
Conversation startedA WhatsApp chat or a call begins.
New messageEvery inbound or outbound message, to mirror the chat live.
Conversation closedThe conversation ends, with its outcome and notes.
Call completedThe call hangs up. Includes duration, recording and transcript.
Appointment bookedThe agent books a slot on the assignee's calendar.
Appointment rescheduledThe date or time changes, with the previous slot included.
Appointment cancelledThe appointment is cancelled, with the reason if captured.
Handoff to a humanThe agent passes the conversation to someone on your team.
Conversion registeredA sale is recorded and credited to a campaign.

Ready to connect Kelpi to your stack?

Tell us what you need to measure and we'll issue test credentials with the full technical documentation.

Request access

See features

No commitment. We'll build a plan tailored to you.