CRM

Name-first search over visible CRM records for the mention picker

postapi.modelmatch.com/v1/crm/records/mention-search

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Body application/json

qstringdefault: ""

Responses

200objectThe viewer-visible records matching the query (or recent).

Show attributes

dataobjectrequired

Show child attributes

resultsobject[]required

Show child attributes

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

locationstring | nullrequired

namestringrequired

subtitlestring | nullrequired

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/mention-search" \
  -H "x-api-key: $MODEL_MATCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "q": ""
  }'

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

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

const { data, error } = await Crm.searchCrmMentionRecords({
  body: {
    q: ""
  }
});

import os
import requests

res = requests.post(
    "https://api.modelmatch.com/v1/crm/records/mention-search",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
    json={
        "q": ""
    },
)
data = res.json()

200 response

{
  "data": {
    "results": [
      {
        "entityId": "<string>",
        "entityType": "lo",
        "location": "<string>",
        "name": "<string>",
        "subtitle": "<string>"
      }
    ]
  }
}