JSON API » people » people/search/list

Gets the fields of all people recursively. This function is rarely used; people/list should normally be used instead.

Input parameters

Requires authentication and the people reports role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
pseudo	Integer	1 to include pseudo-users, 0 not to.	No	0
role	Integer	Only return people with this role ID. 0 for any.	No	0
sort	String	Field to sort by. "customer_name", "description", "failed_count", "last_login", "role_name", or "username".	No	"username"
descending	Integer	1 to sort descending, 0 not to.	No	0

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the people table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/people/search/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "username":"user1@example.com", ... }, { "id":2, "username":"user2@example.com", ... }, ] }

Change history

Version	Changes
3.13	Function added.