List import job rows
Módulo Platform
GET/import-jobsimportJobs.list
A spreadsheet import through detect, map, validate, deduplicate, dry run and commit. Returns a cursor page of import job rows the caller may see. The default order is `created_at` 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 ImportJob
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the import job. |
| 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_mapping_profile_id | string (uuid) | null | Sí | Identifier of the saved mapping profile. |
| target_code | string | Sí | Import target the rows are written to.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| source | "CSV" | "XLSX" | "XLS" | "Google Sheets" | Sí | Source format. |
| original_filename | string | Sí | File name as uploaded.Restricciones: length 1 to 255 |
| storage_object_path | string | Sí | Object path of the uploaded file in the tenant import bucket.Restricciones: length 1 to 1024 |
| import_status | "Uploaded" | "Detected" | "Mapped" | "Validated" | "Committing" | "Committed" | "Undone" | "Failed" | "Canceled" | Sí | Wizard progress. |
| mapping_confirmed_at | string (date-time) | null | Sí | When the person confirmed every column mapping; nothing is validated before it. |
{
"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_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"target_code": "vendors",
"source": "CSV",
"original_filename": "vendors-2026.xlsx",
"storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx",
"import_status": "Uploaded",
"mapping_confirmed_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/import-jobs" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.importJobs.listAll()) {
console.log(row);
}for row in xos.import_jobs.list_all():
print(row)xos import-jobs list --all