query_users
Query various fields in User Management
Name | Type | Required | Example |
---|---|---|---|
userID | Integer | N | 123 |
external_id | String | N | 123 external_id for this user |
username | String | N | john_smith |
company | String | N | Smith Inc |
first_name | String | N | John |
last_name | String | N | Smith |
email | String | N | john.smith@example.com |
country | String | N | United States |
account_type | String | N | Customer This can also be the abbreviated version |
proximity_search | Integer | N | 1 0 or 1 - If 1, allows for approximate results to be returned |
return_count_only | Integer | N | 0 0 or 1 - If 1, will return a "num_results" value instead of returning all user data |
Name | Type | Example |
---|---|---|
Array | json | { userID:{ username:"", first_name:"", company:"", last_name:"", email:"", account_type:"" } ... } |