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 orderpaging.limit is 50paging.offset is 0For field support for filters and sorting, see Supported Filters and Sorting.
To learn how to query branches, see API Query Language.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
sourceBranchProperties.branchId | eq() |
sourceBranchProperties.branchRevision | eq() |
type | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
name | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
lastPublishDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
editorType | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
editorType.editorTypeOptions | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_updatedDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
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:
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.