GetList

Retrieves the list of users. Parameters:

user_key

Search criteria:

status

Optional parameters:

limit - this limits the maximum of returned userss
offset - used together with limit; the list is retrieved from this offset
count - used to count the users

Returns for each user:

id
email
status
first_name
last_name
timezone_id
an array with the groups in which the user is member

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

count

XML request (without count):

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

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassUser" locale="en_US">
    <method type="GetList">
      <user>
        <id>30</id>
        <email>user%40domain.com</email>
        <status>active</status>
        <first_name>0first%20name</first_name>
        <last_name>last%20name</last_name>
        <timezone_id>152</timezone_id>
      </user>
      <user>
        <id>31</id>
        <email>user2%40domain.com</email>
        <status>active</status>
        <first_name>first_name_2</first_name>
        <last_name>last_name2</last_name>
        <timezone_id>152</timezone_id>
        <group_id>31</group_id>
        <group_id>40</group_id>
      </user>
    </method>
  </class>
</result>

XML request (with count):

<?xml version="1.0" encoding="utf-8"?>
<body version="1.0">
  <class type="ClassUser" 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="ClassUser" locale="en_US">
    <method type="GetList">
      <count>5</count>
    </method>
  </class>
</result>