Overview
The FrostBoard API allows Enterprise subscribers to integrate their listings, messages, and analytics with external systems. Whether you're syncing inventory with a dealer management system or building custom reporting, our RESTful API provides the access you need.
https://api.frostboard.com/v1Quick Start
- Subscribe to Enterprise plan
- Enable API access in Basecamp settings
- Generate your API key
- Make your first request
Authentication
All API requests require authentication using a Bearer token in the Authorization header. API keys can be generated and managed in your Basecamp dashboard.
Key Format
fb_live_xxxxxxxxxxxxxxxxExample Request
curl -X GET "https://api.frostboard.com/v1/listings" \
-H "Authorization: Bearer fb_live_your_api_key"Rate Limits
To ensure fair usage and maintain service quality, API requests are rate limited.
1,000 requests/day
Daily limit
100 requests/minute
Burst limit
Rate Limit Headers
X-RateLimit-Remaining: Requests remaining in current window
X-RateLimit-Reset: Unix timestamp when the limit resets
Endpoints Reference
| Method | Endpoint | Description |
|---|---|---|
GET | /listings | Get all your listings |
GET | /listings/{id} | Get single listing |
POST | /listings | Create new listing |
PUT | /listings/{id} | Update listing |
DELETE | /listings/{id} | Delete listing |
GET | /messages | Get all conversations |
GET | /messages/{id} | Get conversation thread |
GET | /analytics/overview | Dashboard stats |
GET | /inquiries | Get all inquiries |
GET | /profile | Get business profile |
PUT | /profile | Update business profile |
Response Format
{
"success": true,
"data": { ... },
"meta": {
"request_id": "req_abc123",
"timestamp": "2026-01-23T20:00:00Z"
}
}Webhooks
Webhooks allow you to receive real-time notifications when events occur in your FrostBoard account. Configure webhook endpoints in your Basecamp settings.
Available Events
| Event | Description |
|---|---|
| listing.created | A new listing was created |
| listing.updated | A listing was updated |
| listing.sold | A listing was marked as sold |
| listing.deleted | A listing was deleted |
| message.received | A new message was received |
| inquiry.created | A new inquiry was submitted |
| review.received | A new review was posted |
Signature Verification
All webhook payloads include an X-FrostBoard-Signature header containing an HMAC-SHA256 signature. Verify this signature using your webhook secret to ensure requests are authentic.
Code Examples
curl -X GET "https://api.frostboard.com/v1/listings" \
-H "Authorization: Bearer fb_live_your_api_key" \
-H "Content-Type: application/json"Ready to integrate?
API access is available exclusively for Enterprise subscribers.
Start EnterpriseQuestions? Contact Sales