CRM

Find candidate entities to link an unmatched record to

postapi.modelmatch.com/v1/crm/match

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

citystring

entityTypeenumrequired

Options:loagentcompanybranch

namestringrequired

statestring

Responses

200objectRanked candidates (best first).

Show attributes

dataobject[]required

Show child attributes

companystring

locationstring

mmaIdstring

namestringrequired

nmlsIdstring

unitsnumber

volumenumber

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/match" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "entityType": "lo",
    "name": "<string>",
    "city": "<string>",
    "state": "<string>"
  }'

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

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

const { data, error } = await Crm.searchCrmMatchCandidates({
  body: {
    entityType: "lo",
    name: "<string>",
    city: "<string>",
    state: "<string>"
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/match",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "entityType": "lo",
        "name": "<string>",
        "city": "<string>",
        "state": "<string>"
    },
)
data = res.json()

200 response

{
  "data": [
    {
      "company": "<string>",
      "location": "<string>",
      "mmaId": "<string>",
      "name": "<string>",
      "nmlsId": "<string>",
      "units": 123.45,
      "volume": 123.45
    }
  ]
}