CRM

Typeahead search for email recipients the caller can see

getapi.modelmatch.com/v1/crm/recipients

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

qstringrequired

Name or address fragment.

limitinteger

Responses

200objectMatching records with a stored email address.

Show attributes

dataobject[]required

Show child attributes

emailstringrequired

entityIdstringrequired

isPrimarybooleanrequired

labelstring | nullrequired

namestringrequired

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/crm/recipients?q=%3Cstring%3E" \
  -H "x-api-key: $MODEL_MATCH_API_KEY"

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

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

const { data, error } = await Crm.searchCrmEmailRecipients({
  query: {
    q: "<q>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/recipients?q=%3Cstring%3E",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": [
    {
      "email": "<string>",
      "entityId": "<string>",
      "isPrimary": true,
      "label": "<string>",
      "name": "<string>"
    }
  ]
}