GetList

Retrieves the list of clients. Parameters:

user_key

Optional parameters:

status - it can be one of the following options:
- active
- suspended
- deleted
limit - this limits the maximum of returned clients
offset - used together with limit; the list is retrieved from this offset
count - used to count the clients

Returns for each client:

id
manager_id - internal use
status - it can be:
- active
- suspended
- deleted
company_name
currency
registered_date

When count is used, it returns the count of the matching clients. This is helpful when the clients are shown on multiple pages.

count

XML request (without count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassClient" locale="en_US">
    <method type="GetList">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <status>active</status>
      <limit>2</limit>
      <offset>1</offset>
    </method>
  </class>
</body>

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassClient" locale="en_US">
    <method type="GetList">
      <client>
        <id>6</id>
        <status>active</status>
        <company_name>company_1</company_name>
        <currency>CAD</currency>
        <registered_date>2005-04-29%2008%3A07%3A29</registered_date>
      </client>
      <client>
        <id>13</id>
        <status>active</status>
        <company_name>company_2</company_name>
        <currency>USD</currency>
        <registered_date>2004-07-29%2016%3A09%3A15</registered_date>
      </client>
    </method>
  </class>
</result>

XML request (with count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassClient" locale="en_US">
    <method type="GetList">
      <user_key>99eb23f072f1be8d1de5ee87d93d3b1c</user_key>
      <status>active</status>
      <count>true</count>
    </method>
  </class>
</body>

XML response (with count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassClient" locale="en_US">
    <method type="GetList">
      <count>11</count>
    </method>
  </class>
</result>