List all locations under your partner

Get every location across every account under your partner, with its account name, address, and current plan. Use this for a partner-level view of everything you manage, or to find a location's store_id. Results are paginated; add call_for=dropdown to get a simple name/ID list instead. Only active and pending locations are listed.

Prerequisites: none beyond the token.

Authentication: Partner token. Lists locations in accounts under your partner and its sub-partners; a user assigned to particular accounts or locations sees only those. account_id and client_account_id must be inside your 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 10

Page size, 10 to 100. Default 10. Values below 10 are raised to 10; above 100 returns 422. With call_for=dropdown, at most 50 entries are returned, and with no limit the whole list is returned.

integer
Defaults to 1

Page number. Default 1.

string
enum
Defaults to all

all (default), active (the location's latest plan is active or expired) or inactive (it's inactive or closed).

Allowed:
integer
enum
Defaults to 1

Ignored by this endpoint. Use plan_subscription.

Allowed:
integer
Defaults to 5994

Return only this account's locations.

string
Defaults to docs-test-acct-001

Return only the locations of the account with this id of yours. Max 255 characters.

integer
Defaults to 3007

Return only this location. Must be an existing location id.

string
Defaults to docs-test-loc-001

Return only the location with this id of yours. Max 255 characters.

string
enum
Defaults to dropdown

dropdown to get a label/value list instead of the paginated list.

Allowed:
string
Defaults to store_name

A field of the response to sort by, e.g. store_name (default), account_name or plan_name.

string
enum
Defaults to ASC

ASC (default) or DESC.

Allowed:
string
enum
Defaults to name

name (also matches client_location_id and storeid), storeid, client_location_id, full_address, plan_name (exact match) or account_name. Use with search_value.

Allowed:
string
Defaults to SAU

The text to search for.

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