List an account's locations

Get the locations the calling user can access, with full address, account, plan and plan features, and a ready-made link to each location's connection page (connect_page_url, for sending to the owner). Use this from an account's point of view; partners use it when acting on behalf of an account, by sending the account's company_id. Results are paginated.

Prerequisites: optional: the account's id (company_id), or one location's id (store_id).

Authentication: Partner or Account token. Without ids, the list is the locations the user behind the token can access. company_id, account_id and store_id must be inside your own account tree; otherwise 422.

Rate limit: none.

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

Page number. Default 1.

Body Params
string
enum
Defaults to store_name

store_name (default), address, zip, city_name, state_code, company_phone, country_name, state_name, storeid or account_name.

string
enum
Defaults to ASC

asc or desc (either case). Default ASC.

Allowed:
string
enum
Defaults to store_name

The field to search: any of the sort_field values. Use with search_value.

string
Defaults to SAU

The text to search for. No < or >. zip and state_code need an exact match; company_phone, country_name, state_name and city_name match from the start; the others match any part.

integer
enum
Defaults to 1

1 to list only locations on an active plan.

Allowed:
integer
Defaults to 5994

List this company's locations: an account, a location, or your partner. Must be inside your account tree.

integer
Defaults to 5994

Same as company_id, for an account only. company_id wins when you send both.

integer
Defaults to 3007

Return only this location. Must be inside your account tree.

integer
Defaults to 10

Page size, 10 to 100. Default 10. Values below 10 are raised to 10; above 100 returns 422.

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