GetAccounts

Overview

Lists Accounts for based on information sent via an http form post.

Post Url

https://www.allclients.com/api/2/GetAccounts.aspx
  • SSL is requred
  • White Label CRM Customers: Replace www.allclients.com with your White Label CRM domain name.

Form Fields

Field Max Length* Required Notes
response_type No Default results will be returned in XML.Set this field value to json to return results in JSON format
apiusername Yes API User Name and password are assigned by AllClients(This is not the user’s API details.)
apipassword Yes API User Name and password are assigned by AllClients(This is not the user’s API details.)
accountid No Returns details only for the specified account
getmailmerge 1 No 0 = Do not include Mail Merge Profile with each account (default)
1 = Include Mail Merge Profile with each account
getgroup 1 No 0 = Do not include Group Info with each account (default)
1 = Include Group Info with each account (will slow down query, especially as number of accounts grow. Only use when necessary)
showpendingdelete 1 No 0 = Do not include accounts with status “Pending Delete” in results (default)1 = Include accounts with status “Pending Delete” in results

Sample Results

Success Message

<results>
  <accounts>
    <account>
      <accountid>10001</accountid>
      <email>test@email.com</email>
      <apikey>ASDFASDF</apikey>
      <mailmerge_fullname>Test Smith</mailmerge_fullname>
      <account_status>Active</account_status>
      <create_date>04/14/2011</create_date>
      <subscription_level>Gold</subscription_level>
      <license_type>Normal</license_type>
      <team_members>2</team_members>
      <mailmergeprofile>
        <fullname>Jeff Smith</fullname>
        <company>ABC Widgets</company>
        <address>123 Main St</address>
        <citystatezip>Anytown, CA 95492</citystatezip>
        <phone>(707) 555-1234</phone>
        <email>test@email.com</email>
        <website>http://www.website.com/<website>
     </mailmergeprofile>
    </account>
  </accounts>
</results>

Sample Failure Message

<?xml version="1.0"?>
<results>
    <error>Authentication failed</error>
</results>