API Service Documentation

Command: query_users

Query various fields in User Management

Request

NameTypeRequiredExample
userIDIntegerN123
external_idStringN123

external_id for this user

usernameStringNjohn_smith
companyStringNSmith Inc
first_nameStringNJohn
last_nameStringNSmith
emailStringNjohn.smith@example.com
countryStringNUnited States
account_typeStringNCustomer

This can also be the abbreviated version

proximity_searchIntegerN1

0 or 1 - If 1, allows for approximate results to be returned

return_count_onlyIntegerN0

0 or 1 - If 1, will return a "num_results" value instead of returning all user data
@param personal_photo String N
@param personal_background String N
@param about_me String N
@param enroller_id Integer N

Response

NameTypeExample
Arrayjson{ userID:{ username:"", first_name:"", company:"", last_name:"", email:"", account_type:"" } ... }