CRM

Check report for an import run (rows, records, lists, notes)

getapi.modelmatch.com/v1/crm/imports/{id}/check

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Import run id.

Responses

200objectThe run checked against the CRM now.

Show attributes

dataobjectrequired

Show child attributes

failednumberrequired

fileRowsnumber | nullrequired

importednumberrequired

inCrmnumberrequired

listsobject[]required

Show child attributes

deletedbooleanrequired

importednumberrequired

inListnumberrequired

listIdstringrequired

namestringrequired

rowsnumberrequired

notesobjectrequired

Show child attributes

inFilenumberrequired

onFailedRowsnumberrequired

presentnumberrequired

rowsnumberrequired

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/imports/<id>/check" \
  -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.checkCrmImport({
  path: {
    id: "<id>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "failed": 123.45,
    "fileRows": 123.45,
    "imported": 123.45,
    "inCrm": 123.45,
    "lists": [
      {
        "deleted": true,
        "imported": 123.45,
        "inList": 123.45,
        "listId": "<string>",
        "name": "<string>",
        "rows": 123.45
      }
    ],
    "notes": {
      "inFile": 123.45,
      "onFailedRows": 123.45,
      "present": 123.45
    },
    "rows": 123.45
  }
}