Saltar al contenido

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

exportJobs.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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

exportJobs.list: ExportJob
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the export job.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
source_labelstringSíWhat is exported, as a saved view or report URN.Restricciones: length 1 to 300
export_formatExportFormatSíExport file format.Restricciones: one of "CSV", "XLSX", "PDF"
classificationClassificationSíColumn classification (Section 8.3).Restricciones: one of "Public", "Internal", "Confidential", "Restricted"
watermarkbooleanSí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_pathstring | nullSíObject path of the file once ready.Restricciones: length 1 to 1024
row_countinteger | nullSíRows exported.Restricciones: range 0 to any
expires_atstring (date-time) | nullSí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