SMS solicitation overage summary

Get a paginated per store plan summary of SMS solicitation volume (count of solicitation SMS sent per store_plan_id), used for the account-side SMS overage display.

Auth: Both — authentication bearer token. Target must sit inside your own account tree, keyed on the optional company_id/store_id; when you omit company_id it defaults to the auth user's own. A Partner login can pass any descendant account/store id (reaching its whole tree). An Account login reaches only its own account and stores under it.

Rate limit: No rate limit.

Request

  • Query: company_id (integer, optional) — filter by account/company id; defaults to auth user's person.company_id. Must belong to auth company hierarchy.
  • Query: store_id (integer, optional) — filter by a single store; also restricts the SMS-count subquery to that store. Must belong to auth company hierarchy.
  • Query: sort_field (string, optional) — one of account_name, store_name, store_plan_id, store_plan_status, store_plan_end, sms_sent_count. Ignored if not in this list (falls back to store name ASC).
  • Query: sort_by (string, optional) — asc|ASC|desc|DESC; default ASC.
  • Query: search_field (string, optional) — one of store_name, account_name, store_plan_status, store_plan_end, store_plan_id (no angle brackets allowed).
  • Query: search_value (string, optional) — value matched against search_field (LIKE for name fields, exact/date otherwise; no angle brackets).
  • Query: limit (integer, optional) — items per page, 10–100 (values below 10 are raised to 10); default 20.

Response{ data: [.] } envelope (paginator: data, links, meta).

  • id (integer) — store_plan id (also surfaced as store_plan_id).
  • account_name (string) — account company name, falling back to the store's location-company name.
  • store_name (string) — the location's name, suffixed with the client location id when one is set (else the storeid).
  • store_plan_id (integer) — store_plan id.
  • store_plan_status (string) — the store plan's status.
  • store_plan_end (string|null) — the store plan's plan_end date.
  • sms_sent_count (integer) — count of solicitation SMS sent for that store plan (0 when none).

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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