Getting Started

Welcome to the BlueSuite API documentation. This guide will help you integrate with BlueSuite to automate workflows, receive real-time webhooks, and build powerful integrations.

Overview

The BlueSuite API allows you to:

Manage contacts, quotes, jobs, invoices, and more via REST API
Receive webhooks when events occur (new requests, quotes, jobs, invoices)
Submit customer requests programmatically
Embed forms on your website
Integrate with Zapier for workflow automation

Quick Start

Get your API key from Settings > Integrations in your BlueSuite dashboard
Choose your integration type:
- REST API v1 - Full CRUD access to contacts, quotes, jobs, invoices, and more
- Webhooks - Receive real-time event notifications
- Requests API - Create customer requests
- Embedded Forms - Add forms to your website

Authentication

All API requests require authentication using an API key. See the Authentication guide for details.

curl -X POST https://app.bluesuite.com/api/webhooks/subscribe \
  -H "Authorization: Bearer wk_abc12345.your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{"trigger_event": "new_request", "webhook_url": "https://your-site.com/webhook"}'

Base URL

REST API v1 requests should be made to:

https://app.bluesuite.com/api/v1

Legacy endpoints (webhooks, forms, requests) use:

https://app.bluesuite.com/api

Response Format

All API responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... }
}

Error responses include an error message:

{
  "success": false,
  "error": "Description of what went wrong"
}

Rate Limits

API requests are rate-limited to ensure fair usage:

REST API v1: 120 requests per minute per key
Webhooks API: 100 requests per minute
Forms API: 100 requests per hour per workspace
Requests API: 60 requests per minute

Need Help?

If you have questions or need assistance, contact support through your BlueSuite dashboard.