CRM

Get one import run

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

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

idstringrequired

Import run id.

Responses

200objectThe import run.

Show attributes

dataobjectrequired

Show child attributes

canUndobooleanrequired

completedAtstring | nullrequired

creatednumberrequired

createdAtstringrequired

createdByUserIdstringrequired

externalSourcestring | nullrequired

failednumberrequired

fileNamestring | nullrequired

fileRowsnumber | nullrequired

idstringrequired

lastUndoAtstring | nullrequired

listsobject[]required

Show child attributes

createdbooleanrequired

deletedbooleanrequired

listIdstringrequired

namestringrequired

objectTypestringrequired

ownerUserIdstring | nullrequired

scopedbooleanrequired

totalnumberrequired

undoRemovednumber | nullrequired

undoneAtstring | nullrequired

undoneByUserIdstring | nullrequired

updatednumberrequired

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>" \
  -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.getCrmImport({
  path: {
    id: "<id>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "canUndo": true,
    "completedAt": "<string>",
    "created": 123.45,
    "createdAt": "<string>",
    "createdByUserId": "<string>",
    "externalSource": "<string>",
    "failed": 123.45,
    "fileName": "<string>",
    "fileRows": 123.45,
    "id": "<string>",
    "lastUndoAt": "<string>",
    "lists": [
      {
        "created": true,
        "deleted": true,
        "listId": "<string>",
        "name": "<string>"
      }
    ],
    "objectType": "<string>",
    "ownerUserId": "<string>",
    "scoped": true,
    "total": 123.45,
    "undoRemoved": 123.45,
    "undoneAt": "<string>",
    "undoneByUserId": "<string>",
    "updated": 123.45
  }
}