Overview
Welcome to the official documentation for Starboard REST API. This documentation provides all the information you need to get up and running, including authentication, request methods, response formats, error handling, and more.
What is Starboard REST API?
The API is a RESTful interface allowing 3rd party developers to interact with Starboard platform programmatically. You can use it to:
- Read quotes, record push outcomes and set a quote's customer
- Access and manipulate CRM data
- Poll for the quotes changed since a given time; see Incremental sync
- Be notified by webhook when a quote is won or changes; see Webhooks
- And much more...
Getting Started
To start using our API, you'll need:
- An API key: if Starboard has turned on self-serve for your company, your company's admins generate one under Settings → Developer settings; otherwise, contact Starboard for a key. See Keys and Companies.
- Basic understanding of REST APIs and HTTP
- A tool for making HTTP requests (like cURL, Postman, or any HTTP client library)
API Documentation Structure
- Security - Authentication and authorization
- Common API Details - Base URLs and headers
- REST API Reference - Complete API endpoints