Get an import row result
Platform module
GET/import-row-results/{id}importRowResults.get
The validation result of one imported row, with a reason per cell. Returns one import row result with its `ETag`. A import row result the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import row result. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: ImportRowResult
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import row result. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| import_job_id | string (uuid) | Yes | Identifier of the import job. |
| row_state | ImportRowState | Yes | Import row result state.Constraints: one of "Valid", "Invalid", "Written", "Refused", "Skipped" |
| reason | string | null | Yes | Why the row is invalid or refused.Constraints: length 1 to 300 |
| import_batch_id | string (uuid) | null | Yes | Identifier of the batch that wrote the row; set exactly when the row is written. |
| sheet_name | string | Yes | Source sheet.Constraints: length 1 to 300 |
| row_number | integer | Yes | One-based row number in the sheet, as the person sees it.Constraints: range 1 to any |
| target_table | string | null | Yes | Table the row was written to.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| target_id | string (uuid) | null | Yes | Identifier of the row written, created, updated or merged into. |
| write_action | "Created" | "Updated" | "Merged" | null | Yes | What the write did. |
| before_image | object | null | Yes | The columns an update or merge changed, as they were before the write; undo restores them. |
| undo_outcome | "Reverted" | "Kept" | null | Yes | Outcome when the batch was undone. |
| undo_reason | string | null | Yes | Why a row was kept: the later edit or the dependent row.Constraints: length 1 to 2000 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"import_job_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"row_state": "Valid",
"reason": "Unknown counterparty type.",
"import_batch_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"sheet_name": "Vendors",
"row_number": 2,
"target_table": "records",
"target_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"write_action": "Created",
"before_image": {
"type": "doc"
},
"undo_outcome": "Reverted",
"undo_reason": "Edited after the import."
}Code samples
curl -X GET "$XOS_BASE_URL/import-row-results/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.importRowResults.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.import_row_results.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos import-row-results get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f