CRM

Relationship cross-reference for a record (in-CRM partners + colleagues)

postapi.modelmatch.com/v1/crm/records/connections

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

branchNamestring

branchNmlsIdstring

companyNamestring

companyNmlsIdstring

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

officeKeystring

officeNamestring

partnerEntityIdsstring[]

Responses

200objectIn-CRM partner ids + colleagues tagged with their list names.

Show attributes

dataobjectrequired

Show child attributes

colleaguesobject[]required

Show child attributes

displayobjectrequired

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

listNamesstring[]required

inCrmstring[]required

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 POST "https://api.modelmatch.com/v1/crm/records/connections" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityId": "<string>",
    "entityType": "lo",
    "branchName": "<string>",
    "branchNmlsId": "<string>",
    "companyName": "<string>",
    "companyNmlsId": "<string>",
    "officeKey": "<string>",
    "officeName": "<string>"
  }'

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

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

const { data, error } = await Crm.getCrmRecordConnections({
  body: {
    entityId: "<string>",
    entityType: "lo",
    branchName: "<string>",
    branchNmlsId: "<string>",
    companyName: "<string>",
    companyNmlsId: "<string>",
    officeKey: "<string>",
    officeName: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/connections",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityId": "<string>",
        "entityType": "lo",
        "branchName": "<string>",
        "branchNmlsId": "<string>",
        "companyName": "<string>",
        "companyNmlsId": "<string>",
        "officeKey": "<string>",
        "officeName": "<string>"
    },
)
data = res.json()

200 response

{
  "data": {
    "colleagues": [
      {
        "display": {
          "branchName": "<string>",
          "branchNmlsId": "<string>",
          "cbsaCode": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "companyNmlsId": "<string>",
          "contactCheckedAt": 123.45,
          "county": "<string>",
          "countyFips": "<string>",
          "location": "<string>",
          "name": "<string>",
          "state": "<string>",
          "subtitle": "<string>",
          "units": 123.45,
          "volume": 123.45,
          "zip": "<string>"
        },
        "entityId": "<string>",
        "entityType": "lo",
        "listNames": [
          "<string>"
        ]
      }
    ],
    "inCrm": [
      "<string>"
    ]
  }
}