Get an export job
Módulo Platform
GET/export-jobs/{id}exportJobs.get
An export of a list or report, subject to data loss prevention rules. Returns one export job with its `ETag`. A export job the caller may not see returns 404.
- Requiere la capacidad data.export.run.
- Alcances de OAuth: data.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the export job. |
| 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_]*)*$ |
Respuesta 200: 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. |
{
"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"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/export-jobs/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.exportJobs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.export_jobs.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos export-jobs get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f