What It Does
When you need a custom integration, you need an API — not screen-scraping. SalesButler's Developer API gives you scoped Bearer tokens (sb_<8charPrefix>_<48charSecret> format, plaintext returned once at creation, stored as SHA-256 hash + prefix), eight scopes (read/write × leads/jobs/invoices/appointments), and clean REST endpoints under /api/v1. Middleware re-checks subscription status and api_access feature on every call so plan downgrades take effect immediately.
Step-by-Step Guide
Create a Token
Generate a token in admin with the scopes you need.
Copy It Once
The plaintext token is shown once at creation — store it securely.
Make Authenticated Calls
Use Authorization: Bearer sb_... on every request to /api/v1/{leads,jobs,invoices,appointments}.
Last-Used Auto-Stamps
Async lastUsedAt updates on every successful call.
Rotate or Expire
Set expiresAt on creation, or revoke a token anytime.
Why You'll Love This Feature
Scoped Bearer Tokens
Eight scopes — read/write × leads, jobs, invoices, appointments.
SHA-256 Hashed
Tokens stored as SHA-256 hash + prefix — plaintext only at creation.
Real-Time Subscription Check
Middleware re-checks subscription status on every call (402 on downgrade).
Optional Expiry
Set expiresAt for time-limited tokens.
Standard REST
Clean /api/v1 endpoints — no custom protocols to learn.
Lead Webhook on POST
POST /api/v1/leads automatically fires the lead.created webhook.
Perfect For
Custom internal lead-import scripts
Mobile app development that wraps SalesButler
Reporting tools that pull data into a data warehouse
Integration with vertical-specific tools not yet supported natively
Programmatic CRUD on appointments from a custom scheduling system