listLocations( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves locations, given the specified filters, sorting, and paging.

Permissions
Manage Blog
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Including Participants
Read bookings calendar - including participants
Manage Calendars
Manage Locations
Read Locations
Manage Events
Manage Portfolio
View SEO Settings
Manage Restaurants - all permissions
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListLocationsOptions

Options to use when retrieving a list of locations.

Returns
Return Type:Promise<ListLocationsResponse>
Errors

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

Did this help?