POST

Query Branches

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 branches, given the provided paging, filtering, and sorting.

Query Branches runs with these defaults, which you can override:

  • updatedDate is sorted in DESC order
  • paging.limit is 50
  • paging.offset is 0

To learn how to query branches, see API Query Language.

PropertyFiltersSort
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
lastPublishDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
type$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
name$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
editorType$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
editorType.editorTypeOptions$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
sourceBranchProperties.branchId$eqNone
sourceBranchProperties.branchRevision$eqNone
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
Manage Site Branches
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?