Skip to main content
The HoopAI Platform API is a RESTful API that gives you programmatic access to every feature in the platform — contacts, conversations, calendars, opportunities, payments, automations, funnels, and more.
New to HoopAI? Start with the Getting Started guide to set up your account before diving into the API.

​
What you can build

Use the API to build marketplace apps, automate workflows, sync external systems, and extend the platform. Common use cases include:
  • CRM automation — Create contacts, update pipelines, and trigger workflows
  • Appointment booking — Manage calendars, slots, and booking widgets
  • Messaging — Send SMS, email, and chat messages across channels
  • Commerce — Process orders, manage products, and generate invoices
  • Marketing — Schedule social posts, manage funnels, and track campaigns

​
Available APIs

​
Generally available

APIDescriptionEndpoints
ContactsFull contact lifecycle — create, search, tag, enroll in campaigns19
ConversationsSend and receive messages across all channels17
CalendarsBooking, appointments, free slots, and availability24
OpportunitiesManage pipeline stages and deal values8
PaymentsOrders, transactions, subscriptions, and providers16
ProductsProduct catalog, pricing, inventory, and collections18
InvoicesCreate, send, and track invoices and estimates30
AccountsManage locations, custom fields, and templates16
UsersManage team members and user accounts4
FormsForm builder, submissions, and exports29
FunnelsFunnel pages, domains, and builder163
WorkflowsList and trigger automation workflows1
APIDescription
BlogsBlog post management, authors, and categories
BusinessesBusiness entity management
CampaignsList and manage drip campaigns
Custom FieldsDefine custom fields on contacts and objects
EmailsEmail builder, templates, and campaign stats
Trigger LinksCreate and manage workflow trigger links
Media LibraryUpload and manage files and folders
ObjectsCustom data objects and records
AssociationsDefine relationships between objects
Social PlannerSchedule and manage social media posts
StoreShipping zones, carriers, and storefront settings
SurveysSurvey management and submission data

​
Base URL

All API requests go to: 
https://services.leadconnectorhq.com
The base URL uses the LeadConnector domain. This is the API infrastructure that powers HoopAI — all data belongs to your HoopAI account.

​
Authentication

The HoopAI Platform API uses OAuth 2.0. Every request requires two headers:
HeaderValueRequired
AuthorizationBearer <access_token>Yes
Version2021-07-28Yes
Content-Typeapplication/jsonFor POST/PUT requests
Get a token by following the OAuth 2.0 Authorization Code flow. Tokens expire after 24 hours — use the refresh token to get a new one.
The Version header is required on every request. Always send 2021-07-28 to ensure stable, predictable behavior across API updates.

​
Quick start

# List contacts for a location
curl -X GET "https://services.leadconnectorhq.com/contacts/?locationId=YOUR_LOCATION_ID&limit=20" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Version: 2021-07-28"

​
Rate limits

ScopeLimit
Per account100 requests / 10 seconds
Token refresh5 requests / minute
Responses include X-RateLimit-Remaining and X-RateLimit-Reset headers. Retry 429 responses with exponential backoff.

​
Error responses

All errors return a JSON body: 
{
  "message": "Invalid token",
  "statusCode": 401
}
StatusMeaning
400Bad request — missing or invalid parameters
401Unauthorized — token missing, expired, or invalid
403Forbidden — token lacks required scope
404Not found
422Unprocessable — validation error
429Rate limit exceeded
500Internal server error

​
Next steps

OAuth 2.0 setup

Get your access token and start making requests

Contacts API

Create and manage your CRM contacts

Conversations API

Send messages across SMS, email, and chat

Calendars API

Manage bookings, appointments, and availability

Payments API

Process orders and manage subscriptions

Webhook events

React to real-time platform events
Last modified on March 6, 2026