queryAutomations( )

Developer Preview

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

Retrieves a list of automations. This includes both automations overridden on a site and preinstalled automations. If a preinstalled automation has been overridden on the site, the method returns the override automation.

Note: The method only returns automations by apps installed on the site.

Learn more about API Query Language.

PROPERTY	SUPPORTED FILTERS & SORTING
`createdBy.appId`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`name`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.status`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`configuration.trigger.appId`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.trigger.triggerKey`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`startsWith()`,`gt()`,`lt()`,`le()`,`ge()`,`ascending()`,`descending()`
`configuration.trigger.filters`	`ascending()`,`descending()`
`configuration.trigger.filterValueSelection.selectedFilterValues`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`hasAll()`,`ascending()`,`descending()`
`origin`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings.readonly`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings.disableDelete`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings.disableStatusChange`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings.actionSettings`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`
`settings.actionSettings.permanentActionIds`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`hasAll()`,`ascending()`,`descending()`
`settings.actionSettings.readonlyActionIds`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`hasAll()`,`ascending()`,`descending()`
`archived`	`eq()`,`ne()`,`exists()`,`in()`,`hasSome()`,`ascending()`,`descending()`

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

Learn more about app permissions.

Method Declaration

Copy

Request

This method does not take any parameters

Returns

Return Type:AutomationsQueryBuilder

Errors

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

Did this help?