Partner-wide location list

Get a paginated list of all store locations under the authenticated partner (aggregated across every account the partner owns), each row joined to its account name, address, and active-plan name + dates. When you set call_for it instead returns a flat label/value list for dropdowns (with an All option prepended when more than one store).

Auth: Partner — authentication, under the partner/ group. Scope is baked into (the caller's partner company id). Filter params (account_id, client_account_id, location_id, client_location_id) are all additionally validated by an ownership check, so values outside the partner's tree yield an empty page.

Rate limit: No rate limit.

Request

  • Query: limit (integer, optional) — page size, default 10.
  • Query: page (integer, optional) — page number.
  • Query: plan_subscription (string, optional) — one of all (default), active, inactive.
  • Query: active_plan (integer, optional) — accepted but ignored by this endpoint; use plan_subscription to filter by plan state.
  • Query: account_id (integer, optional) — account filter; must Must be an existing account inside your own account tree.
  • Query: client_account_id (string, optional, max 255) — external account id, resolved to account_id; an ownership check.
  • Query: location_id (integer, optional) — single store filter; must Must be an existing location.
  • Query: client_location_id (string, optional, max 255) — external location id, resolved to a store; an ownership check.
  • Query: call_for (string, optional) — any value returns a flat label/value dropdown list instead of the paginated table.
  • Query: sort_field (string, optional) — default store_name.
  • Query: sort_by (string, optional) — ASC (default) or DESC.
  • Query: search_field / search_value (string, optional) — column + term to filter on.

Response{ data. } envelope. Paginated SubPartnerStoreList resource collection (data[], links, meta) in the default branch; { status, response: [.] } flat list when you set call_for.

  • data[].id (integer) — store id.
  • data[].name (string) — store name.
  • data[].storeid (string) — store external id.
  • data[].client_location_id (string) — partner-supplied location id.
  • data[].account_name (string) — parent account name.
  • data[].store_name (string) — name - storeid composite.
  • data[].full_address, address1, address2, zip (string) — location address fields.
  • data[].plan_name (string) — active plan name.
  • data[].activation_date, expiry_date, cancellation_date (string|null) — plan window.
  • data[].sub_partner_name (string|null) — owning sub-partner's name when the store belongs to one, else null.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string
string
string
Response

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