Account Search

Jump to bottom Edit New page

Sean Callan edited this page Jun 9, 2020 · 2 revisions

Beans_Account_Search

Returns a list of all accounts.

Parameters

auth_uid (required) INTEGER - The ID for your API key.
auth_key (required) STRING - The API key.
auth_expiration (required) INTEGER - Unique ID tied to your key; changes if you reset your key.
sort_by (optional) - The sort pattern for the returned results: 'newest', 'oldest', 'alpha', 'ralpha'

Returns

accounts - An array of Beans_Account sorted ( by default, 'newest' ).
total_results - Total number of results.
sort_by - The sort method used in the returned results.