Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.hoopai.com/llms.txt

Use this file to discover all available pages before exploring further.

The Associations API lets you define typed relationships between objects in the HoopAI Platform — such as contact-to-contact or contact-to-custom-object — and manage the individual record-level relations that connect specific records. Use it to build rich data models where entities across your account are meaningfully linked and queryable together.

​
Base URL

https://services.leadconnectorhq.com

​
Authentication

Every request must include a bearer token in the Authorization header and the API version in the Version header. 
Authorization: Bearer <access_token>
Version: 2021-07-28
Use an access token generated for a Account user type, or a Private Integration Token scoped to the account.

​
OAuth scopes

ScopeAccess
associations.readonlyRead association type definitions
associations.writeCreate, update, and delete association definitions
associations/relation.readonlyRead record-level relations
associations/relation.writeCreate and delete record-level relations

​
Quick start

Get all association definitions for an account: 
curl -X GET "https://services.leadconnectorhq.com/associations/?locationId=clF1LD04GTUKN3b3XuOj&skip=0&limit=100" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"

​
Endpoints

MethodPathDescription
GET/associations/Get all associations for an account / location
POST/associations/Create Association
GET/associations/{associationId}Get association by ID
PUT/associations/{associationId}Update Association By Id
DELETE/associations/{associationId}Delete Association
GET/associations/key/{key_name}Get association key by key name
GET/associations/objectKey/{objectKey}Get association by object keys
POST/associations/relationsCreate Relation for your associated entities
GET/associations/relations/{recordId}Get all relations By record Id
DELETE/associations/relations/{relationId}Delete Relation
Last modified on March 5, 2026