Planfix API contact.getGroupList

The request to get the list of contact groups looks like this:

<?xml version="1.0" encoding="UTF-8"?>
<request method="contact.getGroupList">
    <account></account>
    <sid></sid>
    <signature></signature>
</request>

Name	Type	Value	Note
account	string	the account on which the request is made с
sid	string(32)	session key	issued as a result of authentication
signature	string(32)	packet signature

Response when the request is successfully executed:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
    <contactGroups count="count" totalCount="totalCount">
        <group>
            <id></id>
            <name></name>
        </group>
        <group>
            <id></id>
            <name></name>
        </group>
        <!-- ... -->
    </contactGroups >
</response>

Name	Type	Value	Note
contactGroups	int	list of groups
contactGroups count	int	number of groups in the list
contactGroups totalCount	int	total number of groups in the list
group		group
group.id	int	group identifier
group.name	string	group name

Otherwise, a response with an error will be returned:

<?xml version="1.0" encoding="UTF-8"?>
<response status="error">
  <code></code>
</response>

Go To

• Planfix API:Contacts
• Error codes
• List of functions