Jobs

Changed on

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/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/jobs/
  • Auth
    HTTP bearer

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' | 'button_field_dispatch' | '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
  • button_field_dispatch - button_field_dispatch
  • 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

  • a3756c326fe1Revision changes
    • breaking

      the response property /////////// became optional for the status

    • breaking

      the /////////// response property's maxLength was unset from 50 for the response status

    • breaking

      added to the ////// response property oneOf list for the response status

    • breaking

      added to the ////////// response property oneOf list for the response status

    • breaking

      added to the ////////// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 to the /////////// response property oneOf list for the response status

    • breaking

      the ////// response's property type changed from integer to string for status

    • breaking

      the /////////// response's property type changed from string to no type for status

    • warning

      added the new connect_mcp_oauth_client enum value to the ////////// response property for the response status

    • warning

      added the new disconnect_mcp_oauth_client enum value to the ////////// response property for the response status

    • warning

      added the new update_mcp_endpoint_tools enum value to the ////////// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////////// to the response with the status

    • info

      added agent discriminator mapping keys to the ////// response property for the response status

    • info

      added agent discriminator mapping keys to the ////////// response property for the response status

    • info

      added agent discriminator mapping keys to the ////////// response property for the response status

    • info

      the /////////// response's property pattern ^[-a-zA-Z0-9_]+$ was removed for the status

  • 8afc69805528Revision changes
    • breaking

      the ///////////// response property's maxLength was unset from 200 for the response status

    • breaking

      the ///////////////// response property's maxLength was unset from 200 for the response status

    • breaking

      the ///////////////// response property's maxLength was unset from 200 for the response status

    • breaking

      added subschema #1 subschema #2 to the ///////////// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 to the ///////////////// response property oneOf list for the response status

    • breaking

      added subschema #1 subschema #2 to the ///////////////// response property oneOf list for the response status

    • breaking

      the ///////////// response's property type changed from string to no type, and format from uri to no format for status

    • breaking

      the ///////////////// response's property type changed from string to no type, and format from uri to no format for status

    • breaking

      the ///////////////// response's property type changed from string to no type, and format from uri to no format for status