Skip to main content
GET
Get referral import status
This endpoint is restricted and not generally available: organizations that have not been enabled receive a 403. Contact your Let’s Do This representative if you’d like access.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

jobId
string
required

The jobId the import returned when it accepted the batch.

Response

200 - application/json

The job's progress so far, and the result for each row it has finished.

The state of a referral import.

results holds one entry per row, with its status and errors. It's the only field that says whether a row was imported, so act on it. It fills up while the job runs, so a processing job shows only the rows finished so far: poll until status is completed.

rowCounts totals results, so a non-zero rowCounts.failed means some rows need attention. status is completed once the job has finished, even if every row failed. counts tracks the job's background work, not your rows.

jobId
string
required
status
enum<string>
required
Available options:
queued,
processing,
completed,
cancelled
counts
ImportJobCounts · object
required

Progress of the job's background work. These count units of work, not your rows: one unit can cover several rows, and a finished unit counts as success even if all its rows failed. Read results for each row's outcome.

rowCounts
ImportRowCounts · object
required

Outcome totals for an import job, folded from results: one count per reported result, not per submitted row. Most imports report one result per submitted row, but an endpoint can report several — a reserved-entry participant row covering a booking reports one result per participant — so total can legitimately exceed the submitted row count and is not a reconciliation check against it. The totals accumulate the same way results does: a processing job counts the results reported so far. A non-zero failed is the signal to inspect results and act on the failures.

results
ReferralImportRowResult · object[]
required