CRM

Get contact methods for many records

getapi.modelmatch.com/v1/crm/contacts

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdsstringrequired

Comma-separated CRM record ids (lo:123456), at most 200.

Responses

200objectContacts keyed by entity id, oldest first (the profile's order; `isPrimary` marks the primary per kind). Records with no contacts, or that the caller can't see, are absent.

Show attributes

dataobjectrequired

Show child attributes

[key: string]object[]

Show child attributes

idstringrequired

isPrimarybooleanrequired

kindstringrequired

labelstring | nullrequired

sourceenumrequired

mm-edited = a user edit of a Market Insights value; user = added by the workspace (by hand, import or enrichment).

Options:usermm-edited

valuenull

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/contacts?entityIds=%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.listCrmContactMethods({
  query: {
    entityIds: "<entityIds>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "key": [
      {
        "id": "<string>",
        "isPrimary": true,
        "kind": "<string>",
        "label": "<string>",
        "source": "user",
        "value": null
      }
    ]
  }
}