Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Purpose: get a list of users, or a single user. 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.

...

Permissions Required: Edit Mobile Workers & Edit Access API's

Authentication and Usage: All URL endpoints should be utilized as part of a cURL authentication command. For more information, please review CommCare's API Authentication Documentation.

Input parameters:

NameDescriptionExample
formatdata format
Supported: json (default), xml
format=xml
groupGroup UUID (optional)group=ac9d34ff59cf6388e4f5804b12276d8a
archivedList archived users instead of active onesarchived=true
extrasAdds extra data fields (this can slow down the API) for recent user activityextras=true

...