Public API

Public API

The Salesbuildr API lets you programmatically access and manage your data. Use it to build custom integrations, automate workflows, or connect Salesbuildr to tools that aren't covered by the built-in integrations.

Note: The Public API is a feature that must be enabled for your account.

API overview

The API follows REST conventions with JSON request and response bodies.

Base URL

All API requests use your tenant-specific URL:

https://[your-tenant-name].salesbuildr.com/public-api/

Authentication

Authenticate by passing your API key in the api-key header:

api-key: your-api-key-here

Generate API keys at Admin > Integrations > API Key.

Documentation

Full API specifications are available at:

• API reference — https://portal.salesbuildr.com/public-api#/ (Redocly docs)
• Interactive docs — https://[your-tenant].salesbuildr.com/public-api/swagger (Swagger UI)
• Webhook docs — https://[your-tenant].salesbuildr.com/public-api/webhooks

Available resources

The API provides access to 13 resource endpoints:

External identifiers

Most resources support operations by external identifier — a reference you provide to link Salesbuildr records to your external system. Use GET/PUT/DELETE /public-api/{resource}/ext/{externalIdentifier} to work with records by their external ID.

Pagination and search

Search endpoints support:

• from and size for pagination
• query for text search
• Resource-specific filters
• Sort field and direction

Rate limits and fair use

Rate limits

Each tenant is limited to 500 API requests per 10-minute rolling window. This limit applies to Public API calls only — internal application requests and built-in PSA integrations do not count.

When the limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header indicating when requests can resume.

The sync state endpoint is exempt from rate limiting.

Rate limit response headers

Every API response includes headers showing your current rate limit status:

Handling rate limits

Follow these best practices to stay within rate limits and build a resilient integration:

• Use webhooks instead of polling. Subscribe to events (e.g., quote.ordered, company.updated) rather than repeatedly calling search endpoints to detect changes.
• Implement exponential backoff. When you receive a 429 response, wait for the number of seconds specified in the Retry-After header, then retry. If the retry also fails, double the wait time before each subsequent attempt.
• Batch where possible. Use batch endpoints (e.g., POST /public-api/product/batch for up to 100 products at a time) instead of creating resources one by one.
• Cache responses. Store data locally and refresh only when needed — avoid fetching the same resource repeatedly within a short window.
• Monitor your usage. Check X-RateLimit-Remaining in response headers to proactively slow down before hitting the limit.

Fair use policy

The API is provided as part of your Salesbuildr subscription for normal integration usage. By using the API, you agree to the following terms:

Permitted uses:

• Synchronizing data between Salesbuildr and your business systems (CRM, PSA, ERP)
• Automating quote creation, product management, or order processing
• Building custom dashboards or reporting tools
• Triggering workflows based on webhook events

Prohibited uses:

• High-volume bulk requests designed to overload the platform
• Continuous polling for changes (use webhooks instead)
• Scraping, data harvesting, or competitive analysis
• Reselling or redistributing API access to third parties
• Circumventing rate limits through multiple API keys or IP rotation
• Any activity that degrades platform performance for other customers

Hosted platform obligations: Salesbuildr is a shared multi-tenant platform. API usage that impacts other customers' experience — even if unintentional — may be throttled or restricted without notice.

Consequences of violation: Salesbuildr reserves the right to restrict API access, suspend accounts, or apply additional usage charges for policy violations. Persistent or intentional abuse may result in account termination.

Policy updates: This policy may be updated at any time. Continued use of the API after changes constitutes acceptance.

For questions about API usage or to request higher rate limits, contact support@salesbuildr.com.

Webhooks

Webhooks notify your external systems in real time when events occur in Salesbuildr. Instead of polling the API for changes, you register endpoint URLs and Salesbuildr pushes event data to them automatically.

Note: Webhooks must be enabled for your account. Navigate to Admin > Integrations > Webhooks to manage your endpoints.

Available events

Salesbuildr supports 16 webhook event types across 6 entities:

Creating a webhook endpoint

1. Navigate to Admin > Integrations > Webhooks
2. Click Add Webhook
3. Configure the endpoint settings:

4. Click Save

You can create multiple endpoints, each subscribing to different events. For example, one endpoint for CRM updates and another for order notifications.

Payload structure

Each delivery sends an HTTP POST with a JSON body:

{  "event": "company.created",  "eventId": "unique-event-id",  "timestamp": "2026-02-20T10:30:00.000Z",  "data": { ... }}

• event — The event type that triggered the delivery
• eventId — A unique identifier for this specific delivery
• timestamp — ISO 8601 timestamp of when the event occurred
• data — The full entity object, using the same structure as the Public API response for that resource

For example, a company.created event delivers the same company object you'd get from GET /public-api/company/:id.

Delivery and retries

• Deliveries are processed asynchronously via a background job queue
• A delivery is considered successful when your endpoint returns any HTTP 2xx status
• Failed deliveries (non-2xx response or timeout) are retried with a 2-second delay between attempts
• Delivery history is visible per endpoint in the admin UI, showing timestamp, event type, HTTP status, and success/failure

Testing webhooks

Click the Send Test button on any configured endpoint to deliver a test event. This verifies:

• Your URL is reachable from Salesbuildr
• Authentication headers are accepted
• Your endpoint returns a 2xx response

The test delivery uses a sample payload with realistic data so you can verify your integration's parsing logic.

Common patterns

CRM synchronization

Subscribe to company.created, company.updated, contact.created, and contact.updated to keep an external CRM in sync with Salesbuildr customer data.

Order fulfillment

Subscribe to quote.ordered and order.created to trigger fulfillment workflows when a quote is converted to an order.

Reporting and analytics

Subscribe to opportunity.status_changed and quote.created to feed sales metrics into a BI tool or dashboard.

Troubleshooting

• Deliveries not arriving — Verify the endpoint is Active, the URL is reachable from the internet, and you're subscribed to the correct events
• Authentication failures — Check that custom headers match what your endpoint expects
• Timeouts — Ensure your endpoint responds within the configured timeout; process webhook data asynchronously if your handler is slow
• Duplicate deliveries — Use the eventId field to deduplicate; retries may re-deliver the same event

See also

• Custom Fields — Admin

• Email — Admin

• Platform — Admin

• Before Your First Call — Getting Started

• Security & Legal — Support