Planfix API userGroup.get

The function of obtaining information about a group. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="userGroup.get">
  <account></account>
  <sid></sid>
  <userGroup>
    <id></id>
  </userGroup>
  <signature></signature>
</request>

Name	Type	Value	Note
id	int	group identifier
signature	string(32)	signature

Response:

<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
  <userGroup>
    <id></id>
    <name></name>
    <userCount></userCount>
  </userGroup>
</response>

Name	Type	Value	Note
id	int	group identifier
name	string	group name
userCount	int	number of users in the group

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:Managing user groups
• Error codes
• List of functions