Skip to main content

Retrieve profiles by conditions

Retrieve profiles by conditions

Authorizations:Token
Query Parameters
_cnd[anonymous]booleanShows only anonymous (true) or registered (false) user profiles
_cnd[orderId]integerFilters profiles by order id
_cnd[referer]stringFilters profiles by referer
_cnd[membership]integerFilters profiles by membership id
_cnd[roles]integerFilters profiles by role(s)
_cnd[permissions]stringFilters profiles by available permission code(s)
_cnd[language]stringFilters profiles by language
_cnd[pattern]stringFilters profiles by name or email substring
_cnd[phone]stringFilters profiles by phone number
_cnd[login]stringFilters profiles by email (OR clause)
_cnd[andLogin]stringFilters profiles by email (AND clause)
_cnd[state]stringFilters profiles by state id (for countries with states)
_cnd[customState]stringFilters profiles by custom state name
_cnd[address]stringFilters profiles by address id
_cnd[userType]stringFilters profiles by user type
_cnd[onlyReal]booleanExclude profile copies (snapshots for certain order)
_cnd[limit]Array of stringsSets the offset (first item) and the limit (second item)
_cnd[orderBy]Array of stringsSets sorting order field

Responses

200Success
Response schema:
Success
Array
gaClientIdstring
socialLoginProviderstring
socialLoginIdstring
pictureUrlstring
mail_chimp_listsArray
mail_chimp_interestsArray
mail_chimp_segmentsArray
auth_phone_numberstring
auth_phone_codestring
authy_idinteger
conversationsArray
profile_idinteger
loginstring
passwordstring
password_hintstring
password_hint_answerstring
passwordResetKeystring
passwordResetKeyDateinteger
access_levelinteger
cms_profile_idinteger
cms_namestring
addedinteger
first_logininteger
last_logininteger
statusstring
statusCommentstring
refererstring
order
eventArray
languagestring
last_shipping_idinteger
last_payment_idinteger
membershipobject
pending_membershipobject
addressesArray
rolesArray
anonymousboolean
forceChangePasswordboolean
dateOfLoginAttemptinteger
countOfLoginAttemptsinteger
searchFakeFieldstring
xcPendingExportboolean