CRM

List a record's activity timeline (newest first)

getapi.modelmatch.com/v1/crm/activity

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Query parameters

entityIdstringrequired

The CRM record id whose timeline to read.

Responses

200objectThe record's timeline entries, newest first.

Show attributes

dataobject[]required

Show child attributes

actorEmailstring | nullrequired

actorImagestring | nullrequired

actorNamestring | nullrequired

actorUserIdstring | nullrequired

bodystring | nullrequired

bodyHtmlstring | nullrequired

createdAtnumberrequired

datanull

editedAtnumber | nullrequired

idstringrequired

kindenumrequired

Options:notesystemautomated

linkedNotesobject[]

Same shape as its parent.

occurredAtnumber | nullrequired

parentIdstring | nullrequired

repliesobject[]

Same shape as its parent.

replyCountnumber

subtypestringrequired

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/activity?entityId=%3Cstring%3E" \
  -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.listCrmActivity({
  query: {
    entityId: "<entityId>"
  }
});

import os
import requests

res = requests.get(
    "https://api.modelmatch.com/v1/crm/activity?entityId=%3Cstring%3E",
    headers={"x-api-key": os.environ["MODEL_MATCH_API_KEY"]},
)
data = res.json()

200 response

{
  "data": [
    {
      "actorEmail": "<string>",
      "actorImage": "<string>",
      "actorName": "<string>",
      "actorUserId": "<string>",
      "body": "<string>",
      "bodyHtml": "<string>",
      "createdAt": 123.45,
      "data": null,
      "editedAt": 123.45,
      "id": "<string>",
      "kind": "note",
      "linkedNotes": [
        {}
      ],
      "occurredAt": 123.45,
      "parentId": "<string>",
      "replies": [
        {}
      ],
      "replyCount": 123.45,
      "subtype": "<string>"
    }
  ]
}