Guides
Getting started, authorization, best practices, MCP overview, and MCP authentication need durable source material.
Developers
Developer docs need trustworthy endpoints, examples, and auth details.
API docs are high-trust pages. Endpoint metadata, examples, authentication notes, and status behavior should stay aligned with the backend that actually serves the API.
What this page covers
The work that turns demand into booked, paid jobs.
Endpoints
Endpoint pages should be generated from backend-owned API metadata where possible.
Browse this section
Developer docs need trustworthy endpoints, examples, and auth details.
GET /contacts
List Contacts
Returns a paginated list of contacts for the authenticated business, sorted by creation date (newest first).
GET /equipment
List Equipment
Returns a paginated list of equipment for the authenticated business, sorted by creation date (newest first).
GET /estimates
List Estimates
Returns a paginated list of estimates for the authenticated business, sorted by creation date (newest first).
GET /events
List Events
Returns published events for the authenticated business, ordered by most recent first. Draft and archived events are excluded. Uses a count-based limit instead of pagination.
GET /business
Get Business Details
Returns full business details for the authenticated business, including email, phone, website, time zone, and account status.
GET /me
Get Business Identity
Returns the authenticated business identity. Use this endpoint to verify your API credentials.
GET /status
Status
Health-check endpoint. Returns the current API status and version. No authentication required.
API Guide
Authorization
All authenticated endpoints use HMAC-SHA256 signature verification. Each request must include three custom headers that prove your identity and protect against replay attacks.
API Guide
Best Practices
Never expose your private key in client-side JavaScript, mobile apps, or public repositories. All API calls should be made from a secure server-side environment.
API Guide
Getting Started
The Local Business Pro REST API lets you programmatically access your business data, including events, account details, and more. All responses are returned as JSON.
API Guide
MCP Authentication
The MCP server uses OAuth 2.0 with PKCE for authentication. When you connect from an AI client like Claude Desktop, Claude Code, or ChatGPT, the OAuth flow is handled automatically — you just log in with your Local Business Pro credentials and authorize the connection. No passwords are shared with the AI assistant. Your connection can be revoked at any time from Settings > Connected Apps in Local Business Pro. Connections remain active until you revoke them or your session expires.
API Guide
MCP Overview
The Model Context Protocol (MCP) is an open standard that lets AI assistants securely connect to external services. With the Local Business Pro MCP server, your AI assistant can: View and update business information, hours, and service areas Search, view, and manage customer contacts Review AI receptionist conversation history View appointments across your calendars Configure your AI receptionist (FAQs, services, personality, rules) Access invoices, estimates, and jobs Run automation functions Work with custom objects (vehicles, pets, etc.) All interactions are secured with OAuth 2.0 authentication. Your password is never shared with the AI assistant.
GET /invoices
List Invoices
Returns a paginated list of invoices for the authenticated business, sorted by creation date (newest first).
GET /jobs
List Jobs
Returns a paginated list of jobs (work orders) for the authenticated business, sorted by creation date (newest first).
GET /offerings
List Offerings
Returns a paginated list of service/product offerings for the authenticated business, sorted by creation date (newest first).