Get users by account info
Get users by email, phoneNumber or thirdParty info
GET
/appid-{appId}/{tenantId}/users/by-accountinfoAuthorization
api-keyAPI key · headerrequiredThe core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.
Path parameters
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Query parameters
emailstringphoneNumberstringthirdPartyIdstringthirdPartyUserIdstringdoUnionOfAccountInfobooleanrequiredHeader parameters
cdi-versionstringX.Y of the X.Y.Z CDI version.
Responses
200The operation was successful
statusstatusOKAllowed:
OKusersauthRecipeUser[]Show propertiesHide properties
Array of
authRecipeUseriduserIdisPrimaryUserbooleantenantIdstenantId[]timeJoinedtimeJoinedemailsemail[]phoneNumbersphoneNumber[]thirdPartyobject[]Show propertiesHide properties
Array of
objectidthirdPartyIduserIdthirdPartyUserIdloginMethodsobject[]Show propertiesHide properties
Array of
objecttenantIdstenantId[]recipeUserIduserIdverifiedbooleantimeJoinedtimeJoinedrecipeIdrecipeIdAllowed:
emailpasswordpasswordlessthirdpartyemailemailphoneNumberphoneNumberthirdPartyobjectShow propertiesHide properties
idthirdPartyIduserIdthirdPartyUserId400error code 400
string401error code 401
string404error code 404
string500error code 500
stringTry it
Server
Authorization
Parameters
Request
curl -X GET "/appid-{appId}/public/users/by-accountinfo?doUnionOfAccountInfo=true" \
-H "api-key: YOUR_API_KEY"const response = await fetch("/appid-{appId}/public/users/by-accountinfo?doUnionOfAccountInfo=true", {
method: "GET",
headers: {
"api-key": "YOUR_API_KEY"
}
});import requests
response = requests.get(
"/appid-{appId}/public/users/by-accountinfo?doUnionOfAccountInfo=true",
headers={
"api-key": "YOUR_API_KEY"
},
)Response
{
"status": "OK",
"users": [
{
"id": "fa7a0841-b533-4478-95533-0fde890c3483",
"isPrimaryUser": true,
"tenantIds": [
"customer1"
],
"timeJoined": 1623918032231,
"emails": [
"johndoe@gmail.com"
],
"phoneNumbers": [
"+14155552671"
],
"thirdParty": [
{
"id": "google",
"userId": 106347997792363870000
}
],
"loginMethods": [
{
"tenantIds": [
"customer1"
],
"recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
"verified": true,
"timeJoined": 1623918032231,
"recipeId": "emailpassword",
"email": "johndoe@gmail.com",
"phoneNumber": "+14155552671",
"thirdParty": {
"id": "google",
"userId": 106347997792363870000
}
}
]
}
]
}"string""Invalid API key""Not Found""Internal Error"