SalesByte

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:

API Comparison

AspectQuotes APIIntegration API
ScopeCompany-levelProfile-level
AuthenticationBearer token in headerUUID in request body (acts as auth key)
OperationsRead (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

View Webhooks Documentation →

Getting Started

For Quotes API (Read Operations)

  1. Obtain your API Bearer token from SalesByte settings
  2. Include the token in the Authorization header
  3. Make GET requests to /api/quotes endpoints

For Integration API (Write Operations)

  1. Set up your integration in SalesByte to obtain your uuid
  2. Configure your quote profiles and templates as needed
  3. Include the uuid in your POST request body (this acts as your authentication key)

Endpoints Overview

MethodEndpointAPIDescription
GET/api/quotesQuotesList all quotes
GET/api/quotes/<key>QuotesGet a single quote
POST/integrations/create_brandawarenessIntegrationCreate a new lead
POST/integrations/create_quoteIntegrationCreate a standard quote
POST/integrations/create_quote/templateIntegrationCreate a quote from template

On this page