...
Permissions Required: Edit Mobile Workers & Edit Access API's
| Name | Description | Example |
|---|---|---|
| format | data format Supported: json (default), xml | format=xml |
| group | Group UUID (optional) | group=ac9d34ff59cf6388e4f5804b12276d8a |
| archived | List archived users instead of active ones | archived=true |
| extras | Adds extra data fields (this can slow down the API) for recent user activity | extras=true |
...
| Name | Description | Example | Notes | |
|---|---|---|---|---|
| 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 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) | If the property begins with a number, it will not be returned when using XML |
...