API REFERENCE
The Zylar API.
A REST API for leads, sequences, inboxes and stats, plus webhooks for every event. JSON in, JSON out. Available on Growth and Agency plans.
Authentication
Create a key in Settings → API. Send it as a bearer token on every request. Keys are scoped to one workspace.
{{ l.name }}
{{ codeAuth }}Rate limits & errors
10 requests per second per key. Over the limit returns 429 with a Retry-After header. Errors use standard HTTP codes and a JSON body.
400bad_requestA field is missing or invalid. See error.field.
401unauthorizedMissing or revoked API key.
404not_foundThe resource does not exist in this workspace.
429rate_limitedSlow down and retry after the header value.
Leads
GET/leads
List leads, newest first. Paginated with a cursor.
sequence_idstring · optionalOnly leads in this sequence.
statusstring · optionalactive, replied, interested, bounced, unsubscribed, completed.
limitinteger · optional1–100. Default 25.
cursorstring · optionalFrom the previous response’s next_cursor.
{{ l.name }}
{{ codeList }}POST/leads
Add up to 1,000 leads to a sequence. Duplicates and blocklisted addresses are skipped and reported.
sequence_idstring · requiredTarget sequence.
leadsarray · requiredObjects with email (required), first_name, last_name, company and any custom fields.
{{ l.name }}
{{ codeAdd }}DELETE/leads/{id}
Remove a lead from all sequences. Their reply history is kept.
Sequences
GET/sequences
List sequences with status and step count.
PATCH/sequences/{id}
Pause or resume a sequence.
statusstring · requiredactive or paused.
{{ l.name }}
{{ codePause }}Inboxes
GET/inboxes
List connected inboxes with health score (0–100), daily limit and status (active, warming, resting).
Stats
GET/stats
Sends, replies, positive replies and meetings, grouped by sequence, step, variant or inbox.
group_bystring · optionalsequence, step, variant, inbox. Default sequence.
from / todate · optionalISO dates. Default last 30 days.
Webhooks
Subscribe an HTTPS endpoint to one or more events. Payloads are signed with X-Zylar-Signature (HMAC-SHA256 of the body with your webhook secret). Failed deliveries retry 5 times over 24 hours.
POST/webhooks
Create a subscription.
urlstring · requiredYour HTTPS endpoint.
eventsarray · requiredlead.replied, reply.interested, reply.ooo, lead.bounced, lead.unsubscribed, sequence.completed, domain.paused.
{{ l.name }}
{{ codeHook }}