Planfix API user.getList

From Planfix
Jump to: navigation, search

Function to get a user list. Request format:

<?xml version="1.0" encoding="UTF-8"?>
<request method="user.getList">
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 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 status="ok">
  <users count="count" totalCount="totalCount">
      <!-- ... -->
      <!-- ... -->
    <!-- ... -->
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">

Go To