Jobs

List all existing jobs. Jobs are task executed asynchronously in the background. You can use the get_job endpoint to read the current progress of the job. The available query parameters depend on the job type selected via the type parameter. Each job type may support additional type-specific filter parameters.

get/api/jobs/

Query parameters

generate_ai_values_field_idinteger

[Only for type='generate_ai_values'] Filter by the AI field ID.

job_idsstring
limitinteger
offsetinteger
statesstring
sync_data_sync_table_data_sync_idinteger

[Only for type='sync_data_sync_table'] Filter by the data sync ID.

type'duplicate_application' | 'install_template' | 'create_snapshot' | 'restore_snapshot' | 'export_applications' | 'import_applications' | 'airtable' | 'duplicate_table' | 'duplicate_field' | 'sync_data_sync_table' | 'duplicate_page' | 'publish_domain' | 'duplicate_automation_workflow' | 'publish_automation_workflow' | 'generate_ai_values' | 'audit_log_export' | 'data_scan_result_export' | 'file_import'

The type of job to filter for. Determines which additional filter fields are available.

  • duplicate_application - duplicate_application
  • install_template - install_template
  • create_snapshot - create_snapshot
  • restore_snapshot - restore_snapshot
  • export_applications - export_applications
  • import_applications - import_applications
  • airtable - airtable
  • duplicate_table - duplicate_table
  • duplicate_field - duplicate_field
  • sync_data_sync_table - sync_data_sync_table
  • duplicate_page - duplicate_page
  • publish_domain - publish_domain
  • duplicate_automation_workflow - duplicate_automation_workflow
  • publish_automation_workflow - publish_automation_workflow
  • generate_ai_values - generate_ai_values
  • audit_log_export - audit_log_export
  • data_scan_result_export - data_scan_result_export
  • file_import - file_import

Response

countinteger nullable required

The number of matching jobs, or null when polling explicit job IDs.

Changes

Changed in 3 of the 6 revisions of this API.124

    • added the optional property jobs/items/oneOf[AirtableImportJobTypeResponse]/database/oneOf[BuilderApplication]/breakpoints to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateApplicationJobTypeResponse]/duplicated_application/allOf[ApplicationApplication]/oneOf[BuilderApplication]/breakpoints to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateApplicationJobTypeResponse]/original_application/allOf[ApplicationApplication]/oneOf[BuilderApplication]/breakpoints to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property jobs/items/oneOf[AirtableImportJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[AuditLogExportJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[CreateSnapshotJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DataScanResultExportJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateApplicationJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateAutomationWorkflowJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateFieldJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicatePageJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[DuplicateTableJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[ExportApplicationsJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[GenerateAIValuesJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[ImportApplicationsJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[InstallTemplateJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[PublishAutomationWorkflowJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[PublishDomainJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[RestoreSnapshotJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[SaaSFileImportJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • added the optional property jobs/items/oneOf[SyncDataSyncTableJobTypeResponse]/error_code to the response with the 200 status

      response-optional-property-added

    • the response's body type/format changed from array/ to object/ for status 200

      response-body-type-changed

    • added the new optional query request parameter sync_data_sync_table_data_sync_id

      new-optional-request-parameter

    • added the required property count to the response with the 200 status

      response-required-property-added

    • added the required property jobs to the response with the 200 status

      response-required-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog