List import job rows
Platform module
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.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| 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).Constraints: 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. |
Response 200: a page of ImportJob
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the import job. |
| 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_mapping_profile_id | string (uuid) | null | Yes | Identifier of the saved mapping profile. |
| target_code | string | Yes | Import target the rows are written to.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| source | "CSV" | "XLSX" | "XLS" | "Google Sheets" | Yes | Source format. |
| original_filename | string | Yes | File name as uploaded.Constraints: length 1 to 255 |
| storage_object_path | string | Yes | Object path of the uploaded file in the tenant import bucket.Constraints: length 1 to 1024 |
| import_status | "Uploaded" | "Detected" | "Mapped" | "Validated" | "Committing" | "Committed" | "Undone" | "Failed" | "Canceled" | Yes | Wizard progress. |
| mapping_confirmed_at | string (date-time) | null | Yes | 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
}Code samples
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