CRM

Get an async import job's status (progress + per-row errors)

getapi.modelmatch.com/v1/crm/import/{jobId}

Authorization

x-api-keystringrequired

API key or OAuth token. See Authentication.

Path parameters

jobIdstringrequired

Job id from a 202 import.

Responses

200objectJob status (queued / running / completed / failed / cancelled).

Show attributes

dataobjectrequired

Show child attributes

completedAtstring

errorstring

errorsUrlstring

failednumberrequired

jobIdstringrequired

resultsUrlstring

startedAtstring

statusenumrequired

Options:queuedrunningcompletedfailedcancelled

succeedednumberrequired

totalnumberrequired

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/import/<jobId>" \
  -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.getCrmImportJob({
  path: {
    jobId: "<jobId>"
  }
});

import os
import requests

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

200 response

{
  "data": {
    "completedAt": "<string>",
    "error": "<string>",
    "errorsUrl": "<string>",
    "failed": 123.45,
    "jobId": "<string>",
    "resultsUrl": "<string>",
    "startedAt": "<string>",
    "status": "queued",
    "succeeded": 123.45,
    "total": 123.45
  }
}