WHwhispa
accounts

Search Accounts

Paginated, filterable working set of the active CRM provider (admin only). Backs the Accounts table and the campaign add-accounts picker.

get/accounts/search

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Query parameters

sort_by'display_name' | 'account_number' | 'phone' | 'account_status' | 'outstanding_amount' | 'arrears_amount' | 'last_activity_at' | 'synced_at' | 'created_at'

Column to sort by: display_name, account_number, phone, account_status, outstanding_amount, arrears_amount, last_activity_at, synced_at, created_at.

sort_order'asc' | 'desc'

Sort direction: asc or desc.

pageinteger
sizeinteger
demo_market'au' | 'us' nullable
qstring nullable

Free-text search (case-insensitive) across display name, account number, email, external id and phone.

statusstring[] nullable

Provider status values to include (case-insensitive, repeatable). Omit for every status.

campaign_idstring uuid nullable

Only accounts with a membership in this campaign.

campaign_assignment'assigned' | 'unassigned' | 'multiple' | 'review' nullable

Filter by current campaign assignment count, or 'review' for accounts waiting on an operator decision.

timezone_status'unknown' | 'manual' nullable

'unknown': no timezone, so the gate will not call the account. 'manual': an operator set the timezone.

called'account' | 'customer' | 'never' nullable

'account': a call is linked to this account. 'customer': a call is linked to this account or another account of the same customer. 'never': neither.

min_balancenumber nullable

Inclusive lower bound on outstanding amount.

max_balancenumber nullable

Inclusive upper bound on outstanding amount.

min_arrearsnumber nullable

Inclusive lower bound on arrears amount.

max_arrearsnumber nullable

Inclusive upper bound on arrears amount.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.