POST

Query Automations


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.trigger.filterValueSelection.selectedFilterValues$eq, $ne, $exists, $in, $hasSome, $hasAllSort: 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

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Set Up Automations
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/automations-service/v2/automations/query

Errors

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

Did this help?