List locations for a menu

Get a simple name/id list of the locations the calling user can access. Use this to populate a location picker in your own app. Send search or limit to get a short, filtered list instead of every location.

Prerequisites: none beyond the token.

Authentication: Partner or Account token. The list is always the locations the user behind the token can access: a Partner token sees every location under its tree, an Account token only its own account's locations.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
enum
Defaults to 1

1 to list only locations on an active plan. 0 (default): all.

Allowed:
integer
enum
Defaults to 1

1 to add the All entry even when there's only one location.

Allowed:

Return only locations whose name, storeid or client_location_id contains this text. Max 255 characters. No All entry is added while searching.

integer
Defaults to 10

The most locations to return when searching, 10 to 50. Default 10 when you send search. Values below 10 are raised to 10; above 50 returns 422. With neither search nor limit, every location is returned.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json