List import row result rows
Módulo Platform
GET/import-row-resultsimportRowResults.list
The validation result of one imported row, with a reason per cell. Returns a cursor page of import row result rows the caller may see. The default order is `id` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad org.settings.read.
- Alcances de OAuth: org.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de ImportRowResult
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the import row result. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| import_job_id | string (uuid) | Sí | Identifier of the import job. |
| row_state | ImportRowState | Sí | Import row result state.Restricciones: one of "Valid", "Invalid", "Written", "Refused", "Skipped" |
| reason | string | null | Sí | Why the row is invalid or refused.Restricciones: length 1 to 300 |
| import_batch_id | string (uuid) | null | Sí | Identifier of the batch that wrote the row; set exactly when the row is written. |
| sheet_name | string | Sí | Source sheet.Restricciones: length 1 to 300 |
| row_number | integer | Sí | One-based row number in the sheet, as the person sees it.Restricciones: range 1 to any |
| target_table | string | null | Sí | Table the row was written to.Restricciones: pattern ^[a-z][a-z0-9_]*$ |
| target_id | string (uuid) | null | Sí | Identifier of the row written, created, updated or merged into. |
| write_action | "Created" | "Updated" | "Merged" | null | Sí | What the write did. |
| before_image | object | null | Sí | The columns an update or merge changed, as they were before the write; undo restores them. |
| undo_outcome | "Reverted" | "Kept" | null | Sí | Outcome when the batch was undone. |
| undo_reason | string | null | Sí | Why a row was kept: the later edit or the dependent row.Restricciones: length 1 to 2000 |
{
"data": [
{
"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."
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/import-row-results" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.importRowResults.listAll()) {
console.log(row);
}for row in xos.import_row_results.list_all():
print(row)xos import-row-results list --all