Skip to main content
There are two ways to authenticate with the HoopAI API:
MethodBest for
Private Integration keyYour own account — instant setup, long-lived token
OAuth 2.0Marketplace apps that access other users’ accounts
For getting started, use a Private Integration key. It’s the fastest path to a working API call.

​
Create a Private Integration

1

Open Settings

In your HoopAI dashboard, click Settings in the left sidebar.
2

Go to Private Integrations

Select Integrations, then click Private Integrations.
3

Create a new integration

Click + Add Integration. Give it a clear name — something like My Automation or Data Sync Script.
Create Private Integration
4

Select permissions

Choose only the scopes your integration needs. Granting fewer permissions reduces risk if a key is exposed.
API Permission Scopes
Common scopes:
ScopeWhat it allows
Contacts (Read/Write)Get, create, update, and delete contacts
Conversations (Read/Write)Read threads, send messages
Calendars (Read/Write)List calendars, create appointments
Opportunities (Read/Write)Manage deals and pipeline stages
Payments (Read)View invoices and transactions
5

Save and copy your key

Click Save. Your API key appears once — copy it now and store it securely.
This key will not be shown again after you leave the page. Save it in a password manager or environment variable immediately.

​
Using your key in requests

Every API request requires two headers: 
curl -X GET "https://services.leadconnectorhq.com/contacts/?locationId=YOUR_LOCATION_ID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Version: 2021-07-28"
HeaderValuePurpose
AuthorizationBearer YOUR_API_KEYAuthenticates your request
Version2021-07-28Pins the API to a stable version — always send this

​
Keep your key secure

  • Never commit API keys to git — use environment variables
  • Use separate keys for development and production
  • Rotate keys immediately if you suspect exposure
  • Delete unused integrations to reduce your attack surface

​
When to use OAuth instead

Switch to OAuth 2.0 when you’re building an app that needs to access other users’ HoopAI accounts (e.g., a marketplace app). See the OAuth 2.0 guide for the full setup.

​
Next step

Make your first request

Test your key with a live API call and see what comes back
Last modified on March 6, 2026