API Reference Overview

curl https://zeplo.ai/api/v1/contacts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "x-channel-id: YOUR_CHANNEL_ID"

curl https://zeplo.ai/api/v1/contacts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "x-channel-id: YOUR_CHANNEL_ID"

API Reference

The Zeplo API is organized around REST. All endpoints accept and return JSON. The API is split into two layers:

Internal API

Base URL: https://zeplo.ai/api Used by the dashboard frontend. Requires session-based authentication.

Most internal API endpoints require an authenticated session (cookie). For external integrations, use the REST API v1.

REST API v1 (External)

Base URL: https://zeplo.ai/api/v1 The public API for external integrations. Requires API key authentication via the x-api-key header.

Authentication

curl https://zeplo.ai/api/v1/contacts \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "x-channel-id: YOUR_CHANNEL_ID"

Resources

Resource	Endpoints	Description
Messages	4	Send and retrieve messages
Conversations	5	Manage conversations
Contacts	6	CRUD contacts and groups
Campaigns	7	Bulk messaging campaigns
Templates	6	WhatsApp message templates
Automations	9	Workflow automations
Channels	8	WhatsApp channel management
Webhooks	5	Webhook configuration
Media	3	File upload and retrieval
Analytics	3	Reporting and metrics
Teams	5	Team member management
Groups	5	Contact group management
Subscriptions	6	Plans and subscription management
Payments	4	Payment processing
Notifications	4	Notification management
Settings	6	Platform configuration
Support	4	Support ticket system
Knowledge Base	4	AI training and widget
REST API v1	7	External API endpoints

Pagination

List endpoints support cursor-based pagination:

Parameter	Type	Default	Description
`page`	integer	1	Page number
`limit`	integer	20	Items per page (max: 100)
`search`	string	-	Search filter
`sortBy`	string	`created_at`	Sort field
`sortOrder`	string	`desc`	`asc` or `desc`

Paginated response format

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

API Documentation

REST API v1 (External)

Messages

Conversations

Contacts

Campaigns

Templates

Automations

Channels

Webhooks

Media

Analytics

Teams

Groups

Subscriptions & Plans

Payments

Notifications

Settings

Support Tickets

Knowledge Base & Training

User Management

API Reference Overview

API Reference

Internal API

REST API v1 (External)

Authentication

Resources

Paginated response format

​API Reference

​Internal API

​REST API v1 (External)

​Authentication

​Resources

​Pagination

​Paginated response format

API Reference

Internal API

REST API v1 (External)

Authentication

Resources

Pagination

Paginated response format