CRM

Get custom-field values for one or many records

getapi.modelmatch.com/v1/crm/custom-values

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdstring

entityIdsstring

Responses

200objectSingle: values keyed by field id. Bulk: keyed by entity id then field id.

Show attributes

dataone ofrequired

Show child attributes

Option 1object

Show child attributes

[key: string]object

Option 2object

Show child attributes

[key: string]object

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/custom-values" \
  -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.getCrmCustomValues();

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/custom-values",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": {
    "key": {
      "bool": true,
      "date": 123,
      "multi": [
        "<string>"
      ],
      "num": 123.45,
      "text": "<string>"
    }
  }
}