CRM

Get a list with its members

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Responses

200objectThe list + members, or null when not found / not visible.

Show attributes

dataobject | nullrequired

Show child attributes

listobjectrequired

Show child attributes

accessobject[]

Per-user editor/viewer grants, oldest first — no org-wide grant, never the owner. Always present on GET /lists (every scope) and GET /lists/{id}; omitted on write results.

canManageboolean

createdAtnumberrequired

defaultViewenumrequired

Layout the list opens in for viewers who haven't picked one: the records table or a status kanban board.

Options:tablekanban

hasMemberboolean

idstringrequired

memberCountnumberrequired

namestringrequired

objectTypeenumrequired

Options:peoplecompanies

ownerUserIdstringrequired

sourceTemplateobject | nullrequired

visibilityenumrequired

Options:privateorganizationshared

membersobject | null[]required

Show child attributes

addedAtnumberrequired

displayobjectrequired

entityIdstringrequired

entityTypeenumrequired

Options:loagentcompanybranch

lastActivityAtnumber | null

overridesobject

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/lists/<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.getCrmList({
  path: {
    id: "<id>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "list": {
      "access": [
        {
          "permission": "editor",
          "userId": "<string>"
        }
      ],
      "canManage": true,
      "createdAt": 123.45,
      "defaultView": "table",
      "hasMember": true,
      "id": "<string>",
      "memberCount": 123.45,
      "name": "<string>",
      "objectType": "people",
      "ownerUserId": "<string>",
      "sourceTemplate": {
        "canManage": true,
        "id": "<string>",
        "kind": "saved",
        "name": "<string>"
      },
      "visibility": "private"
    },
    "members": [
      {
        "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>"
      }
    ]
  }
}