Retrieves locations, given the specified filters, sorting, and paging.
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
name | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
description | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
default | $eq, $ne, $exists, $in, $any | Sort: ✗ |
status | $eq, $ne, $exists, $in, $any | Sort: ✗ |
locationType | $eq, $ne, $exists, $in, $any | Sort: ✗ |
fax | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
timeZone | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
email | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
phone | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.country | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.subdivision | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.city | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.postalCode | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.streetAddress.number | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.streetAddress.name | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.streetAddress.apt | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.formattedAddress | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.hint | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
address.geocode.latitude | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ✗ |
address.geocode.longitude | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ✗ |
businessSchedule.periods.openDay | $eq, $ne, $exists, $in, $any | Sort: ✗ |
businessSchedule.periods.openTime | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
businessSchedule.periods.closeDay | $eq, $ne, $exists, $in, $any | Sort: ✗ |
businessSchedule.periods.closeTime | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
businessSchedule.specialHourPeriod.startDate | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
businessSchedule.specialHourPeriod.endDate | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
businessSchedule.specialHourPeriod.isClosed | $eq, $ne, $exists, $in, $any | Sort: ✗ |
businessSchedule.specialHourPeriod.comment | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ✗ |
revision | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ✗ |
archived | $eq, $ne, $exists, $in, $any | Sort: ✗ |
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.