List Users

Purpose: get a list of users. The list of users may be presented to the end user as a simple list of user names, where each name includes a hyperlink to access a list of cases owned by the user.

Base URL: https://www.commcarehq.org/api/[domain]/users/

Input parameters:

Name	Description	Example
format	data format (optional) Supported: xml (default), json	format=xml
group_id	Group UUID (optional)	group=ac9d34ff59cf6388e4f5804b12276d8a

Output values:

Name	Description	Example
user_id	User UUID	3c5a623af057e23a32ae4000cf291339
username	User name of user, including domain	jdoe@example.commcarehq.org
first_name	First name of user	John
last_name	Last name of user	Doe
default_phone_number	Primary phone number of user	+50253311399
email	Email address of user	john.doe@example.org
phone_numbers	List of all phone numbers of the user	(see examples)
groups	List of all group ids belonging to the user	(see examples)
user_data	Any additional custom data associated with the user	(see examples)

Sample usage:

https://www.commcarehq.org/api/demo/users/?format=xml

Sample output:

JSON:

{users: [
    { type: "user",
      id: "3c5a623af057e23a32ae4000cf291339",
      username: "jdoe@example.commcarehq.org",
      first_name: "John",
      last_name: "Doe", 
      default_phone_number: "+50253311399",
      email: "jdoe@example.org",
      phone_numbers: [
          "+50253311399",
          "+50253314588"
      ],
      groups: [
          "9a0accdba29e01a61ea099394737c4fb",
          "b4ccdba29e01a61ea099394737c4fbf7"
      ],
      user_data: {
          chw_id: "13/43/DFA"
      }
    },
    { type: "user",
      id: "3c5a623af057e23a32ae4000cf2943248",
      username: "jsmith@example.commcarehq.org",
      first_name: "Jane",
      last_name: "Smith",
      default_phone_number: "+50253311388",
      email: "jsmith@example.org",
      phone_numbers: [
          "+50253311388"
      ],
      groups: [],
      user_data: {
          village: "Patna",
	  husband_name: "Bob Smith"
      }
    },
    ...
]}

XML:

<users>
	<user user_id="3c5a623af057e23a32ae4000cf291339" >
		<username>jdoe@example.commcarehq.org</username>
		<first_name>John</first_name>
		<last_name>Doe</last_name>
		<default_phone_number>+50253311399</default_phone_number>
		<email>jdoe@example.org</email>
		<phone_numbers>
			<phone_number>+50253311399</phone_number>
			<phone_number>+50253314588</phone_number>
		</phone_numbers>
		<groups>
			<group id="9a0accdba29e01a61ea099394737c4fb" />
			<group id="b4ccdba29e01a61ea099394737c4fbf7" /> 
		</groups>
		<user_data>
		        <data key="chw_id">13/43/DFA</data>
		</user_data>
	</user>
	<user user_id="3c5a623af057e23a32ae4000cf2943248">
		<username>jsmith@example.commcarehq.org</username>
		<first_name>Jane</first_name>
		<last_name>Smith</last_name>
		<default_phone_number>+50253311388</default_phone_number>
		<email>jsmith@example.org</email>
		<phone_numbers>
			<phone_number>+50253311388</phone_number>
		</phone_numbers>
		<groups />
		<user_data>
		        <data key="village">Patna</data>
		        <data key="husband_name">Bob Smith</data>
		</user_data>
	</user>
	...
</users>