Getting started
API base URL: https://services.leadconnectorhq.com
This endpoint is operated by the underlying LeadConnector infrastructure; your Omnium Hub branding and account access are unchanged.
Always include Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN and Version: v3. Use Content-Type: application/json for JSON request bodies.
Authentication
An Omnium Hub administrator must generate a sub-account Private Integration Token with the necessary scopes. Use contacts.readonly to read contacts and contacts.write for write operations. Keep credentials on your backend or secure secret storage; never expose them in browser-side code.
Quick test: Search contacts
curl -X POST https://services.leadconnectorhq.com/contacts/search \
-H "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \
-H "Version: v3" \
-H "Content-Type: application/json" \
-d '{}'Contacts endpoints
The contacts operations below are a focused subset. They are not a complete export of every CRM module or every contact-related operation.
Search contacts
Search and filter contacts. Supply an object as the request body.
POST /contacts/search
curl --request POST \
--url "https://services.leadconnectorhq.com/contacts/search" \
--header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \
--header "Version: v3" \
--header "Content-Type: application/json" \
--data '{}'Get a contact
Retrieve contact details by ID.
GET /contacts/{contactId}
curl --request GET \ --url "https://services.leadconnectorhq.com/contacts/YOUR_CONTACT_ID" \ --header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \ --header "Version: v3"
Create a contact
Create a contact in an Omnium Hub sub-account.
POST /contacts/
curl --request POST \
--url "https://services.leadconnectorhq.com/contacts/" \
--header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \
--header "Version: v3" \
--header "Content-Type: application/json" \
--data '{"locationId":"YOUR_LOCATION_ID","firstName":"Jane","lastName":"Doe","email":"jane@example.com"}'Update a contact
Update an existing contact.
PUT /contacts/{contactId}
curl --request PUT \
--url "https://services.leadconnectorhq.com/contacts/YOUR_CONTACT_ID" \
--header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \
--header "Version: v3" \
--header "Content-Type: application/json" \
--data '{"firstName":"Jane"}'Delete a contact
Delete an existing contact. Treat as destructive.
DELETE /contacts/{contactId}
curl --request DELETE \ --url "https://services.leadconnectorhq.com/contacts/YOUR_CONTACT_ID" \ --header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \ --header "Version: v3"
Find duplicate contacts
Look up potential duplicate records by locationId and email or number.
GET /contacts/search/duplicate
curl --request GET \ --url "https://services.leadconnectorhq.com/contacts/search/duplicate" \ --header "Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN" \ --header "Version: v3"
Opportunities
Relevant token scope(s): opportunities.readonly.
Search opportunities including monetaryValue, pipeline and stage.
GET /opportunities/search
curl -G 'https://services.leadconnectorhq.com/opportunities/search?locationId=YOUR_LOCATION_ID&status=all&limit=100' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Retrieve a deal by ID.
GET /opportunities/YOUR_OPPORTUNITY_ID
curl -G 'https://services.leadconnectorhq.com/opportunities/YOUR_OPPORTUNITY_ID' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Calls and emails
Relevant token scope(s): conversations.readonly, conversations/message.readonly.
Find conversations. Use Version: 2021-04-15 for this operation.
GET /conversations/search
curl -G 'https://services.leadconnectorhq.com/conversations/search?locationId=YOUR_LOCATION_ID' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: 2021-04-15'
Retrieve call and email messages.
GET /conversations/YOUR_CONVERSATION_ID/messages
curl -G 'https://services.leadconnectorhq.com/conversations/YOUR_CONVERSATION_ID/messages?type=TYPE_CALL,TYPE_EMAIL' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Retrieve full individual email details.
GET /conversations/messages/email/YOUR_MESSAGE_ID
curl -G 'https://services.leadconnectorhq.com/conversations/messages/email/YOUR_MESSAGE_ID' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Download a recording if available.
GET /conversations/messages/YOUR_MESSAGE_ID/locations/YOUR_LOCATION_ID/recording
curl -G 'https://services.leadconnectorhq.com/conversations/messages/YOUR_MESSAGE_ID/locations/YOUR_LOCATION_ID/recording' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Get a transcription if available.
GET /conversations/locations/YOUR_LOCATION_ID/messages/YOUR_MESSAGE_ID/transcription
curl -G 'https://services.leadconnectorhq.com/conversations/locations/YOUR_LOCATION_ID/messages/YOUR_MESSAGE_ID/transcription' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Email campaign statistics
Relevant token scope(s): emails/stats.readonly.
Read campaign delivery, opens, clicks, replies and related metrics.
GET /emails/locations/YOUR_LOCATION_ID/campaigns/stats/email-campaigns/YOUR_CAMPAIGN_ID
curl -G 'https://services.leadconnectorhq.com/emails/locations/YOUR_LOCATION_ID/campaigns/stats/email-campaigns/YOUR_CAMPAIGN_ID' \ -H 'Authorization: Bearer YOUR_PRIVATE_INTEGRATION_TOKEN' \ -H 'Version: v3'
Reporting notes
Opportunity values are stored in monetaryValue; they are not necessarily revenue received. Conversation messages represent activity; call recordings and transcriptions depend on availability. Email campaign statistics are aggregate and are separate from per-contact email messages.
Use pagination for complete exports and protect contact/call/email data as personal information.
Notes & scope
Source: endpoint structure and versioning were curated from publicly available v3 LeadConnector documentation. Consult the upstream API source for changes and advanced request and response schemas. Some operations may require additional data or have provider-specific constraints.
No proxy is included. This documentation does not create a new API at omniumhub.com. To use an omniumhub.com API hostname, Omnium Hub would need to deploy and secure an API gateway/proxy separately.
Hosting: upload this index.html to a static site at docs.omniumhub.com/api/ (after DNS/hosting setup). The JSON file can be imported into compatible OpenAPI tooling.