CRM

List curated CRM records of an object type

getapi.modelmatch.com/v1/crm/members

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

objectTypeenumrequired

Options:peoplecompanies

ownerenum

me scopes to the caller's records; omit for everyone.

Options:me

Responses

200objectThe visible records of the object type, newest first.

Show attributes

dataobject | null[]required

Show child attributes

addedAtnumberrequired

displayobjectrequired

Show child attributes

branchNamestring

branchNmlsIdstring

cbsaCodestring

citystring

companyNamestring

companyNmlsIdstring

contactCheckedAtnumber

countystring

countyFipsstring

locationstring

namestringrequired

statestring

subtitlestring

unitsnumber

volumenumber

zipstring

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

lastActivityAtnumber | null

overridesobject

Show child attributes

officeobject

[key: string]string

ownerUserIdstring | null

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/members?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.listCrmMembers({
  query: {
    objectType: "people"
  }
});

import os
import requests

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

200 response

{
  "data": [
    {
      "addedAt": 123.45,
      "display": {
        "branchName": "<string>",
        "branchNmlsId": "<string>",
        "cbsaCode": "<string>",
        "city": "<string>",
        "companyName": "<string>",
        "companyNmlsId": "<string>",
        "contactCheckedAt": 123.45,
        "county": "<string>",
        "countyFips": "<string>",
        "location": "<string>",
        "name": "<string>",
        "state": "<string>",
        "subtitle": "<string>",
        "units": 123.45,
        "volume": 123.45,
        "zip": "<string>"
      },
      "entityId": "<string>",
      "entityType": "lo",
      "lastActivityAt": 123.45,
      "overrides": {
        "office": {
          "city": "<string>",
          "key": "<string>",
          "lat": 123.45,
          "lon": 123.45,
          "name": "<string>",
          "state": "<string>"
        }
      },
      "ownerUserId": "<string>"
    }
  ]
}