API Documentation
This documentation provides details on the SalesByte APIs available for integrating external systems with your SalesByte instance.
APIs Overview
SalesByte provides two distinct APIs with different authentication methods and scopes:
Quotes API
Company-level read access with Bearer token authentication
Integration API
Profile-level write access with UUID authentication
Webhooks
Receive real-time notifications for quote events
API Comparison
| Aspect | Quotes API | Integration API |
|---|---|---|
| Scope | Company-level | Profile-level |
| Authentication | Bearer token in header | UUID in request body (acts as auth key) |
| Operations | Read (GET) | Write (POST) |
| Base URL | /api/quotes | /integrations/* |
Quotes API
The newer Quotes API provides read access to quotes at the company level:
- List All Quotes - Retrieve paginated quotes with filtering and sorting
- Get Quote - Retrieve a single quote by its public key
View Quotes API Documentation →
Integration API
The Integration API provides write access to create quotes and leads at the profile level:
- Create Leads - Generate lead quotes for lead generation activities
- Create Quotes - Generate sales quotes with products and alternatives
- Create Quotes from Templates - Quickly generate quotes from predefined templates
View Integration API Documentation →
Webhooks
Receive real-time notifications when events occur in SalesByte:
- Quote Checkout - Triggered when a quote is signed or purchased by a customer
Getting Started
For Quotes API (Read Operations)
- Obtain your API Bearer token from SalesByte settings
- Include the token in the
Authorizationheader - Make GET requests to
/api/quotesendpoints
For Integration API (Write Operations)
- Set up your integration in SalesByte to obtain your
uuid - Configure your quote profiles and templates as needed
- Include the
uuidin your POST request body (this acts as your authentication key)
Endpoints Overview
| Method | Endpoint | API | Description |
|---|---|---|---|
| GET | /api/quotes | Quotes | List all quotes |
| GET | /api/quotes/<key> | Quotes | Get a single quote |
| POST | /integrations/create_brandawareness | Integration | Create a new lead |
| POST | /integrations/create_quote | Integration | Create a standard quote |
| POST | /integrations/create_quote/template | Integration | Create a quote from template |