CRM

Batch-read record overrides

getapi.modelmatch.com/v1/crm/overrides

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdsstringrequired

Comma-separated record ids.

Responses

200objectThe overlay per entity id.

Show attributes

dataobjectrequired

Show child attributes

[key: string]object

Show child attributes

officeobject

[key: string]string

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/overrides?entityIds=lo%3A1%2Clo%3A2" \
  -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.getCrmOverrides({
  query: {
    entityIds: "lo:1,lo:2"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/overrides?entityIds=lo%3A1%2Clo%3A2",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "key": {
      "office": {
        "city": "<string>",
        "key": "<string>",
        "lat": 123.45,
        "lon": 123.45,
        "name": "<string>",
        "state": "<string>"
      }
    }
  }
}