GET

List Locations


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 Bookings Services and Settings
Manage Bookings
Manage Calendars
Manage Bookings - all permissions
Read Bookings - all read permissions
Read Bookings - Including Participants
Read bookings calendar - including participants
Manage Locations
Manage Portfolio
Manage Restaurants - all permissions
Read Locations
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/locations/v1/locations

Query Params
sort.fieldNamestringmaxLength 512

Name of the field to sort by.


sort.orderstring

Sort order.


paging.limitintegerminimum 0format int32

Number of items to load.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.


includeArchivedboolean

Whether to include archived locations in the response.

Default: false

Response Object
locationsArray <Location>

Retrieved locations.


pagingMetadataPagingMetadata

Paging info.

List Locations
Request
cURL
curl -X GET \ 'https://www.wixapis.com/locations/v1/locations/' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "locations": [ { "id": "3c707097-0d3c-4fd6-b5e5-b8aeb4d8ddd2", "name": "4th Avenue", "default": false, "status": "ACTIVE", "locationType": "UNKNOWN", "timeZone": "America/New_York", "address": { "country": "US", "subdivision": "NY", "city": "Brooklyn", "streetAddress": { "number": "", "name": "4th Avenue", "apt": "" }, "formattedAddress": "4th Avenue, Brooklyn, NY, USA", "geocode": { "latitude": 40.6490336, "longitude": -74.0097993 } }, "revision": "1", "archived": false }, { "id": "8341511b-4e89-4a6d-bbac-bac72f421c41", "name": "West 13th Street", "default": true, "status": "ACTIVE", "locationType": "UNKNOWN", "fax": "1800-555-XXX", "timeZone": "America/New_York", "email": "owner-email@domain.com", "phone": "1800-555-XXX", "address": { "country": "US", "subdivision": "NY", "city": "New York", "postalCode": "10011", "streetAddress": { "number": "47", "name": "West 13th Street", "apt": "" }, "formattedAddress": "47 W 13th St, New York, NY 10011, USA", "hint": "Near the school", "geocode": { "latitude": 40.736545, "longitude": -73.9961841 } }, "businessSchedule": { "periods": [], "specialHourPeriod": [] }, "revision": "2", "archived": false }, { "id": "97dc43b5-521b-48e9-8710-a3543f00f0ca", "name": "3rd Avenue", "default": false, "status": "ACTIVE", "locationType": "UNKNOWN", "fax": "1800-555-XXX", "timeZone": "America/New_York", "email": "employee-email@domain.com", "phone": "1800-555-XXX", "address": { "country": "US", "subdivision": "NY", "city": "New York", "postalCode": "10003", "streetAddress": { "number": "33", "name": "3rd Avenue", "apt": "" }, "formattedAddress": "Alumni Hall, 33 3rd Ave, New York, NY 10003, USA", "geocode": { "latitude": 40.7302968, "longitude": -73.98899449999999 } }, "revision": "2", "archived": false }, { "id": "ea50573e-35fa-47ca-bba7-3e45a935d9bc", "name": "South Figueroa Street", "default": false, "status": "ACTIVE", "locationType": "UNKNOWN", "timeZone": "America/New_York", "address": { "country": "US", "subdivision": "CA", "city": "Los Angeles", "postalCode": "90015", "streetAddress": { "number": "1111", "name": "South Figueroa Street", "apt": "" }, "formattedAddress": "STAPLES Center, South Figueroa Street, Los Angeles, CA, USA", "geocode": { "latitude": 34.0430175, "longitude": -118.2672541 } }, "revision": "1", "archived": false }, { "id": "f67e9ba1-a40f-4b2a-82de-5a67b2622125", "name": "Broadway", "default": false, "status": "ACTIVE", "locationType": "UNKNOWN", "timeZone": "America/New_York", "address": { "country": "US", "subdivision": "NY", "city": "Yonkers", "streetAddress": { "number": "", "name": "Broadway", "apt": "" }, "formattedAddress": "Broadway, Yonkers, NY, USA", "geocode": { "latitude": 40.944635, "longitude": -73.8942072 } }, "revision": "1", "archived": false } ], "pagingMetadata": { "count": 5, "hasNext": false } }
Errors

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

Did this help?