POST

Query Automations

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of automations, given the provided paging, filtering, and sorting.

Returns both site-specific automations and preinstalled automations. When a preinstalled automation has been overridden on the site, the method returns the overridden automation, not the original one.

Note: Only returns automations created by apps installed on the site.

Learn more about API Query Language.

PropertyFiltersSort
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
configuration.trigger.appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
configuration.trigger.triggerKey$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
configuration.trigger.filtersSort: ASC, DESC
configuration.status$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
origin$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings.readonly$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings.disableDelete$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings.disableStatusChange$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings.actionSettings$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
settings.actionSettings.permanentActionIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
settings.actionSettings.readonlyActionIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
archived$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
createdBy.appId$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Set Up Automations
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?