CRM

Load one template with its fields

getapi.modelmatch.com/v1/crm/templates/{id}

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Responses

200objectThe template, or null when missing / not accessible.

Show attributes

dataobjectrequired

Show child attributes

createdAtnumberrequired

fieldCountnumberrequired

fieldsobject[]required

Show child attributes

configobject | nullrequired

idstringrequired

keystringrequired

labelstringrequired

optionsobject[] | nullrequired

sortOrdernumberrequired

typeenumrequired

Options:textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags

idstringrequired

namestringrequired

objectTypeenumrequired

Options:peoplecompanies

ownerUserIdstringrequired

sharedCountnumberrequired

updatedAtnumberrequired

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/templates/<id>" \
  -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.getCrmTemplate({
  path: {
    id: "<id>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "createdAt": 123.45,
    "fieldCount": 123.45,
    "fields": [
      {
        "config": {
          "key": null
        },
        "id": "<string>",
        "key": "<string>",
        "label": "<string>",
        "options": [
          {
            "color": "<string>",
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "sortOrder": 123.45,
        "type": "text"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "objectType": "people",
    "ownerUserId": "<string>",
    "sharedCount": 123.45,
    "updatedAt": 123.45
  }
}