CRM

List the caller's lists (picker mode with ?entityId adds hasMember)

getapi.modelmatch.com/v1/crm/lists

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

objectTypeenum

Options:peoplecompanies

entityIdstring

scopeenum

Options:visibleall

Responses

200objectVisible lists (own + org-wide + shared-with-me); scope=all returns every workspace list for admins.

Show attributes

dataobject[]required

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.

Show child attributes

permissionenumrequired

Options:editorviewer

userIdstringrequired

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

Show child attributes

canManagebooleanrequired

Caller may edit/share it (owner or workspace admin). Always false for library templates.

idstringrequired

kindenumrequired

Options:savedlibrary

namestringrequired

Resolved at read time.

visibilityenumrequired

Options:privateorganizationshared

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" \
  -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.listCrmLists();

import os
import requests

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

200 response

{
  "data": [
    {
      "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"
    }
  ]
}