Get a paginated list of accounts (bundle_id=3) under the authenticated partner, with owner email, status, location/active-plan counts and current plan name. Pass call_for=dropdown for a flat label/value list instead.
Auth: Partner — authentication under the partner/account group; controller hard-requires the caller's company to be bundle_id == 1 (partner) else 403. Scope is the partner's own account tree, further narrowed by the user's assign_brand/assign_location assignments. Optional account_id/client_account_id filters are re-checked by an ownership check so a value outside the partner's accounts yields an empty page.
Rate limit: No rate limit.
Request
- Query:
limit(integer, optional) — page size, default 10. - Query:
page(integer, optional) — page number. - Query:
sort_field(string, optional) — one ofcompany_name,email,status,plan_name; defaultcompany_name. - Query:
sort_by(string, optional) —asc/ASC/desc/DESC; defaultASC. - Query:
search_field(string, optional) —company_name,email,status, orplan_name(pairs withsearch_value). - Query:
search_value(string, optional) — like-match value (exact status_id whensearch_field=status). - Query:
active_plan(in:0,1, optional) — when 1, restrict to accounts with an active store plan. - Query:
call_for(string, optional) —dropdownreturns a flat label/value list (prepends{label:'All',value:''}when more than one account). - Query:
account_id(integer, optional) — filter to one account by internal company id; must belong to the auth partner. - Query:
client_account_id(string, max 255, optional) — partner-supplied external id, resolved to the account within the partner only.
Response — { data. } envelope. Default: a paginated collection (paginator: current_page, data[], per_page, total, links, etc.). Each item:
id(integer) — account company id.company_name(string) — account name.email(string) — owner user email.account_status(string) —Active/Inactive/Paused(derived from person.status_id).status(integer) — raw person.status_id.total_locations(integer) — count of store ids under the account.store_ids(integer[]) — active/pending store ids.total_active_plan(integer) — distinct stores with active/expired store_plans.plan_name(string|null) — account-level plan name.client_account_id(string|null) — partner-supplied external id.
When call_for=dropdown, the envelope instead carries { status: 'success', response: [{label, value}.] }.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
