Integrations

Check whether records can be sent to HubSpot

getapi.modelmatch.com/v1/integrations/hubspot/status

Reports whether your HubSpot account is connected, which record types your workspace has set up to send, and whether the connected account is the one that setup was built for. Read-only — call it before offering to send anything.

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Responses

200objectReadiness per record type

Show attributes

configuredPortalIdstring | nullrequired

The HubSpot account your workspace's setup was built for. When this differs from portalId, pushes are refused.

connectedbooleanrequired

maxRecordsPerPushnumberrequired

objectsobject[]required

Show child attributes

codestring

entityenum

The kind of Model Match record the ids refer to — originator for loan officers, agent for real estate agents. Required, and checked against what your workspace configured: if they disagree the request is refused rather than writing records built from the wrong mapping.

Options:agentoriginator

mappedFieldCountnumber

matchOnstring

The HubSpot field used to match existing records.

objectenumrequired

Which kind of HubSpot record to write. Your workspace decides which Model Match records feed each one.

Options:contactcompany

readybooleanrequired

reasonstring

portalIdstring | nullrequired

The HubSpot account you have connected, when known.

portalMismatchbooleanrequired

400objectValidation error

401objectUnauthorized

403objectForbidden (authenticated, but missing required context — e.g. no active organization)

404objectNot found

413objectResponse payload too large — detail endpoint capped to fit Lambda response limits

503objectSearch timed out or the cluster is overloaded — retry after `Retry-After` seconds.

curl -X GET "https://api.modelmatch.com/v1/integrations/hubspot/status" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

import { createClient, Integrations } from "@model-match/api";

createClient({ apiKey: process.env.MODEL_MATCH_API_KEY });

const { data, error } = await Integrations.getHubspotPushStatus();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/integrations/hubspot/status",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "configuredPortalId": "<string>",
  "connected": true,
  "maxRecordsPerPush": 123.45,
  "objects": [
    {
      "code": "<string>",
      "entity": "agent",
      "mappedFieldCount": 123.45,
      "matchOn": "<string>",
      "object": "contact",
      "ready": true,
      "reason": "<string>"
    }
  ],
  "portalId": "<string>",
  "portalMismatch": true
}