HoopAI Platform API

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

API	Description	Endpoints
Contacts	Full contact lifecycle — create, search, tag, enroll in campaigns	19
Conversations	Send and receive messages across all channels	17
Calendars	Booking, appointments, free slots, and availability	24
Opportunities	Manage pipeline stages and deal values	8
Payments	Orders, transactions, subscriptions, and providers	16
Products	Product catalog, pricing, inventory, and collections	18
Invoices	Create, send, and track invoices and estimates	30
Accounts	Manage locations, custom fields, and templates	16
Users	Manage team members and user accounts	4
Forms	Form builder, submissions, and exports	29
Funnels	Funnel pages, domains, and builder	163
Workflows	List and trigger automation workflows	1

View all APIs

API	Description
Blogs	Blog post management, authors, and categories
Businesses	Business entity management
Campaigns	List and manage drip campaigns
Custom Fields	Define custom fields on contacts and objects
Emails	Email builder, templates, and campaign stats
Trigger Links	Create and manage workflow trigger links
Media Library	Upload and manage files and folders
Objects	Custom data objects and records
Associations	Define relationships between objects
Social Planner	Schedule and manage social media posts
Store	Shipping zones, carriers, and storefront settings
Surveys	Survey management and submission data

Base URL

All API requests go to:

https://services.leadconnectorhq.com

The base URL uses a platform infrastructure domain. This is the API service that powers HoopAI — all data belongs to your HoopAI account.

Authentication

The HoopAI Platform API uses OAuth 2.0. Every request requires two headers:

Header	Value	Required
`Authorization`	`Bearer <access_token>`	Yes
`Version`	`2021-07-28`	Yes
`Content-Type`	`application/json`	For 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"

const response = await fetch(
  'https://services.leadconnectorhq.com/contacts/?locationId=YOUR_LOCATION_ID&limit=20',
  {
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
      'Version': '2021-07-28'
    }
  }
);
const { contacts } = await response.json();

import requests

response = requests.get(
    'https://services.leadconnectorhq.com/contacts/',
    params={'locationId': 'YOUR_LOCATION_ID', 'limit': 20},
    headers={
        'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
        'Version': '2021-07-28'
    }
)
contacts = response.json()['contacts']

Rate limits

Scope	Limit
Per account	100 requests / 10 seconds
Token refresh	5 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
}

Status	Meaning
`400`	Bad request — missing or invalid parameters
`401`	Unauthorized — token missing, expired, or invalid
`403`	Forbidden — token lacks required scope
`404`	Not found
`422`	Unprocessable — validation error
`429`	Rate limit exceeded
`500`	Internal 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

Developer Basics

Guides

API Overview

Concepts & Guides

Authentication

What you can build

Available APIs

Generally available

Base URL

Authentication

Quick start

Rate limits

Error responses

Next steps

OAuth 2.0 setup

Contacts API

Conversations API

Calendars API

Payments API

Webhook events

​What you can build

​Available APIs

​Generally available

​Base URL

​Authentication

​Quick start

​Rate limits

​Error responses

​Next steps

OAuth 2.0 setup

Contacts API

Conversations API

Calendars API

Payments API

Webhook events

What you can build

Available APIs

Generally available

Base URL

Authentication

Quick start

Rate limits

Error responses

Next steps