GetList

Retrieves the list of groups. Parameters:

user_key

Optional parameters:

client_id - if not specified, the client_id will be chosen from the database using user_key
limit - this limits the maximum of returned groups
offset - used together with limit; the list is retrieved from this offset
count - used to count the groups

Returns for each group in the list:

id
name

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

count

XML request (without count):

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

XML response (without count):

<?xml version="1.0" encoding="utf-8"?>
<result>
  <class type="ClassGroup" locale="en_US">
    <method type="GetList">
      <group>
        <id>37</id>
        <name>test</name>
      </group>
      <group>
        <id>54</id>
        <name>test2</name>
      </group>
    </method>
  </class>
</result>

XML request (with count):

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

XML response (with count):

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