Skip to main content
The Opportunities API provides full management of sales pipeline records in the HoopAI Platform. Use it to create and update opportunities, move deals through pipeline stages, assign monetary values, query and search opportunities by pipeline or contact, retrieve pipeline definitions and stage configurations, manage followers on opportunity records, and upsert opportunities to avoid duplicates. It is designed for integrating external CRMs, building custom sales dashboards, and automating deal progression logic.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

All endpoints require a Bearer token and an API version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
See OAuth 2.0 to obtain an access token.

​
OAuth scopes

ScopeAccess
opportunities.readonlyRead opportunities, pipelines, and lost reasons
opportunities.writeCreate, update, delete, and upsert opportunities; manage followers

​
Quick start

Create a new opportunity in a pipeline: 
curl -X POST https://services.leadconnectorhq.com/opportunities/ \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineId": "pipeline_abc123",
    "locationId": "sadadya1u12basyhasd",
    "name": "Website Redesign Project",
    "pipelineStageId": "stage_xyz456",
    "status": "open",
    "monetaryValue": 5000,
    "contactId": "contact_abc123"
  }'

​
Endpoints

MethodPathDescription
POST/opportunities/Create opportunity
GET/opportunities/searchSearch opportunity (GET)
POST/opportunities/searchSearch opportunities (POST)
POST/opportunities/upsertUpsert opportunity
GET/opportunities/{id}Get opportunity
PUT/opportunities/{id}Update opportunity
DELETE/opportunities/{id}Delete opportunity
PUT/opportunities/{id}/statusUpdate opportunity status
POST/opportunities/{id}/followersAdd followers
DELETE/opportunities/{id}/followersRemove followers
GET/opportunities/pipelinesGet pipelines
GET/opportunities/lost-reasonGet lost reasons
Last modified on March 4, 2026