API Documentation


Search for customers.


auth_uid INTEGER The ID for your API key.
auth_key STRING The API key.
auth_expiration INTEGER Unique ID tied to your key; changes if you reset your key.
sort_by STRING The sort pattern for the returned results: 'newest', 'oldest'
page INTEGER The page to return.
page_size INTEGER The number of results on each page.
search_email STRING Search a wildcard match on an email address.
search_name STRING Search a wildcard match on a name ( including first, last, and company name ).
search_number STRING Search a wildcard match on a phone or fax number.
search_and BOOLEAN Require all provided fields to match.


customers ARRAY An array of Beans_Customer.
total_results INTEGER Total number of results.
sort_by STRING The sort method used in the returned results.
pages INTEGER The total number of pages of results.
page INTEGER The currently returned page index.