# The Patient import object

> Attributes of a BloomText Patient import and the endpoints that return it.

Source: https://www.bloomtext.com/developers/api/reference/patient-import-object/

Bulk imports of patient records. Patient API.

### Attributes

- `id` (string, required): Unique ID of the import.

- `status` (running, completed, failed, required): Progress of the import.

- `rows` (integer, required): Rows received.

- `created` (integer, required): Rows that created a new patient.

- `matched` (integer, required): Rows that matched an existing patient.

- `failed` (integer, required): Rows that couldn't be imported.

- `results` (array of PatientImportRow or null): One result per row, once the import finishes. Null while it's running.

  Child attributes:
- `row` (integer, required): Row number, starting at 1.

- `outcome` (created, matched, failed, required): What happened to the row.

- `matched_by` (mrn, phone, email, null): Which field matched, for `matched` rows.

- `patient_id` (UUID or null): The created or matched patient.

- `error` (string or null): Why the row failed, like `phone_or_email_required`.

- `created_at` (timestamp, required): When the import started.

### Endpoints

| Method | Path | Endpoint |
| --- | --- | --- |
| POST | `/patient-imports` | [Import patients](https://www.bloomtext.com/developers/api/reference/create-patient-import/) |
| GET | `/patient-imports/{importId}` | [Retrieve an import](https://www.bloomtext.com/developers/api/reference/get-patient-import/) |

```json filename="The Patient import object"
{
  "id": "imp_71c2",
  "status": "running",
  "rows": 2,
  "created": 0,
  "matched": 0,
  "failed": 0,
  "results": null,
  "created_at": "2026-09-21T15:04:05Z"
}
```