Skip to main content
GET
/
api
/
integration-sources
/
{source_id}
/
saas-associations
List Saas Associations
curl --request GET \
  --url https://config.heyhumm.ai/api/integration-sources/{source_id}/saas-associations \
  --header 'Authorization: Bearer <token>'
[
  {
    "integration_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "from_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to_object_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "association_type_id": "<string>",
    "association_label": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "association_category": "PLATFORM_DEFINED",
    "metadata_": {},
    "relationship_type": "FOREIGN_KEY",
    "status": "SUGGESTED",
    "score": 123,
    "evidence": {},
    "is_active": true
  }
]

Documentation Index

Fetch the complete documentation index at: https://heyhumm.ai/docs/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
source_id
string<uuid> | null
required

Query Parameters

​
from_object_id
string<uuid> | null
​
to_object_id
string<uuid> | null
​
status
enum<string> | null

Filter associations by status

Available options:
SUGGESTED,
APPROVED,
REJECTED
​
type
enum<string> | null

Filter associations by relationship type

Available options:
FOREIGN_KEY,
INFERRED,
MANUAL
​
organization_id
string<uuid> | null
​
resource_id
string<uuid> | null
​
integration_source_id
string<uuid> | null
​
data_source_id
string<uuid> | null
​
context_source_id
string<uuid> | null
​
job_id
string<uuid> | null

Response

Successful Response

​
integration_source_id
string<uuid>
required

The integration source this association belongs to

​
from_object_id
string<uuid>
required

The source SaaS object

​
to_object_id
string<uuid>
required

The target SaaS object

​
association_type_id
string
required

Platform-specific type identifier (e.g., HubSpot's numeric ID or Salesforce's API name)

​
association_label
string
required

Human-readable label (e.g., 'Contact to Company')

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
association_category
string
default:PLATFORM_DEFINED

Category of association (e.g., 'PLATFORM_DEFINED', 'USER_DEFINED', 'CUSTOM')

​
metadata_
Metadata · object
​
relationship_type
enum<string>
default:FOREIGN_KEY

Relationship type (platform vendor, inferred heuristic, manual override)

Available options:
FOREIGN_KEY,
INFERRED,
MANUAL
​
status
enum<string>
default:SUGGESTED

Review status for the relationship

Available options:
SUGGESTED,
APPROVED,
REJECTED
​
score
number | null

Confidence score assigned by inference pipeline (0.0-1.0)

​
evidence
Evidence · object

Supporting evidence for inferred relationships

​
is_active
boolean
default:true

Whether this association is active/usable in the catalog