CRM

List custom fields applicable to a view

getapi.modelmatch.com/v1/crm/fields

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

objectTypeenumrequired

Options:peoplecompanies

listIdstring

Also include this list's list-scoped fields.

Responses

200objectObject-scoped fields plus any requested list-scoped fields.

Show attributes

dataobject[]required

Show child attributes

configobject | nullrequired

Show child attributes

[key: string]null

idstringrequired

keystringrequired

labelstringrequired

listIdstring | nullrequired

objectTypeenumrequired

Options:peoplecompanies

optionsobject[] | nullrequired

Show child attributes

colorstring

idstringrequired

labelstringrequired

outcomeenum | null

Reporting classification (status fields only). Absent = in-progress. Seed ids won/lost classify by convention when absent; null explicitly un-classifies them (in-progress).

Options:wonlostnull

scopeenumrequired

Options:objectlist

sortOrdernumberrequired

typeenumrequired

Options:textnumbercurrencydateselectmultiselecturlratingcheckboxstatustags

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/fields?objectType=people" \
  -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.listCrmCustomFields({
  query: {
    objectType: "people"
  }
});

import os
import requests

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

200 response

{
  "data": [
    {
      "config": {
        "key": null
      },
      "id": "<string>",
      "key": "<string>",
      "label": "<string>",
      "listId": "<string>",
      "objectType": "people",
      "options": [
        {
          "color": "<string>",
          "id": "<string>",
          "label": "<string>",
          "outcome": "won"
        }
      ],
      "scope": "object",
      "sortOrder": 123.45,
      "type": "text"
    }
  ]
}