List export job rows
Módulo Platform
GET/export-jobsexportJobs.list
An export of a list or report, subject to data loss prevention rules. Returns a cursor page of export job rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad data.export.run.
- Alcances de OAuth: data.
- 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 ExportJob
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the export 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. |
| source_label | string | Sí | What is exported, as a saved view or report URN.Restricciones: length 1 to 300 |
| export_format | ExportFormat | Sí | Export file format.Restricciones: one of "CSV", "XLSX", "PDF" |
| classification | Classification | Sí | Column classification (Section 8.3).Restricciones: one of "Public", "Internal", "Confidential", "Restricted" |
| watermark | boolean | Sí | True for Confidential and Restricted exports: PDFs and images carry the viewer email and time. |
| export_status | "Queued" | "Rendering" | "Ready" | "Failed" | "Expired" | Sí | Export progress. |
| storage_object_path | string | null | Sí | Object path of the file once ready.Restricciones: length 1 to 1024 |
| row_count | integer | null | Sí | Rows exported.Restricciones: range 0 to any |
| expires_at | string (date-time) | null | Sí | When the download link stops working. |
{
"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",
"source_label": "urn:xpms:saved_view:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"export_format": "CSV",
"classification": "Restricted",
"watermark": false,
"export_status": "Queued",
"storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/exports/vendors.csv",
"row_count": 120,
"expires_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/export-jobs" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.exportJobs.listAll()) {
console.log(row);
}for row in xos.export_jobs.list_all():
print(row)xos export-jobs list --all