API Reference

Build Powerful Integrations

Everything you need to integrate ByteDesk into your workflow. RESTful API, webhooks, SDKs, and comprehensive documentation.

API at a Glance

A powerful, well-documented REST API designed for developers.

Authentication

API key and OAuth 2.0 authentication with fine-grained permissions.

Rate Limits

Generous rate limits with burst capacity. 1,000 req/min on Professional, 5,000 on Enterprise.

Security

TLS 1.3 encryption, IP allowlisting, and webhook signature verification.

Versioning

Stable API versioning with 12-month deprecation windows and migration guides.

API Endpoints

Explore the full set of resources available through our REST API.

Contacts

Create, read, update, and manage your contact database.

GET/api/v1/contacts
POST/api/v1/contacts
GET/api/v1/contacts/:id
PUT/api/v1/contacts/:id
DELETE/api/v1/contacts/:id

Campaigns

Manage email campaigns and automation sequences.

GET/api/v1/campaigns
POST/api/v1/campaigns
POST/api/v1/campaigns/:id/send
GET/api/v1/campaigns/:id/stats

Funnels

Build and manage sales funnels programmatically.

GET/api/v1/funnels
POST/api/v1/funnels
GET/api/v1/funnels/:id/pages
PUT/api/v1/funnels/:id/publish

Webhooks

Subscribe to real-time event notifications.

GET/api/v1/webhooks
POST/api/v1/webhooks
DELETE/api/v1/webhooks/:id
POST/api/v1/webhooks/:id/test

Quick Start

Get started with a simple API call.

cURL
curl -X GET https://api.bytedesk.ai/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Official SDKs

JavaScript
npm install @bytedesk/sdk
Python
pip install bytedesk
PHP
composer require bytedesk/sdk
Ruby
gem install bytedesk

Ready to Start Building?

Get your API key and start integrating ByteDesk in minutes.