Planfix API user.getList

Function to get a user list. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.getList">
  <account></account>
  <sid></sid>
  <status></status>
  <onlyOnline></onlyOnline>
  <userGroup>
    <id></id>
  </userGroup>
  <sortType></sortType>
  <pageCurrent></pageCurrent>
  <pageSize></pageSize>
  <filters>
    <filter>
      <type></type>
      <operator></operator>
      <value></value>
    </filter>
    ...
  </filters>
</request>

Name	Type	Value	Note
status	enum	user status	see the list of valid values in the user statuses section. Ignored if a group is specified
onlyOnline	bool	show only employees online
userGroup.id	int	group identifier (group filter)
sortType	enum	sorting type	see the list of valid values in the user sorting types section
pageCurrent	int	current page	0 - used to get the number of employees
pageSize	int	size of the list to be retrieved	not more than 100
filters		additional filters	see the list and format of valid values in the employee filters section

Response:

<response status="ok">
  <users count="count" totalCount="totalCount">
    <user>
      <!-- ... -->
    </user>
    <user>
      <!-- ... -->
    </user>
    <!-- ... -->
  </users>
</response>

Name	Type	Value	Note
users		list of users
users count	int	number of users in the list
users totalCount	int	number of users that meet the request conditions
users.user		user description, see the full description of the structure in the user.get section

Otherwise, an error response will be returned:

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

Go To

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