Mozillians/API-Specification/List Users/: Difference between revisions
Jump to navigation
Jump to search
Bsternthal (talk | contribs) |
Bsternthal (talk | contribs) |
||
Line 92: | Line 92: | ||
| Specifies format of result. Defaults to 'json'. | | Specifies format of result. Defaults to 'json'. | ||
|} | |} | ||
Arguments country, region, city, is_vouched, email, skills, languages, groups can be combined. The returned results will be logically ANDed. | |||
== Example Response == | == Example Response == |
Revision as of 21:22, 4 October 2012
listUsers
Returns user information based on search parameters.
Authentication
This method required authentication.
Arguments
Argument | Type | Required | Mozilla App Only | Description |
---|---|---|---|---|
app_name | string | Y | N | Your registered app name. This is case sensitive. |
app_key | string | Y | N | Your app key |
is_vouched | string [true false] |
N | N (Required For Community) | Flag to return users that are vouched or not. |
string | N | Y | Return user with matching email. | |
country | string | N | Y | Return users with matching country. |
region | string | N | Y | Return users with matching region. |
city | string | N | Y | Return users with matching city. |
skills | string | N | Y | Return users with matching skills. Skills can be comma separated to filter users with any matched skills. |
languages | string | N | Y | Return users with matching languages. Languages can be comma separated to filter users with any matched languages. |
groups | string | N | Y | Return users with matching groups. Groups can be comma separated to filter users with any matched groups. |
limit | integer | N | Y | Limit answer to [number] results. |
offset | integer | N | Y | Skip [number] results. Defaults to 0. |
format | string [json xml] |
N | N | Specifies format of result. Defaults to 'json'. |
Arguments country, region, city, is_vouched, email, skills, languages, groups can be combined. The returned results will be logically ANDed.
Example Response
Return Codes
Code | Description |
---|---|
200: OK | All OK ;) |
401: Unauthorized | Wrong AppName or AppKey or App not activated |