listJobs( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Lists data movement jobs for the current site. The listJobs() method builds a query to retrieve a list of jobs for the current site, and returns a JobsQueryBuilder object. The returned object contains the query definition, which is typically used to run the query using the find() method.

You can refine the query by chaining JobsQueryBuilder methods onto the query. JobsQueryBuilder methods enable you to sort, filter, and control the results listJobs() returns.

listJobs() runs with these JobsQueryBuilder defaults, which you can override:

The methods chained to listJobs() are applied in the order they're called. For example, if you apply ascending('firstName') and then descending('age'), the results are sorted first by firstName, and then, if there are multiple results with the same firstName, the items are sorted by age.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage All Data Resources
Manage Data Items
Data Mover Manage Jobs
Read Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListJobsOptions
Returns
Return Type:Promise<ListJobsResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?