Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Search for a User by Email

Returns User details for an account by a provided email.

GET
/api/v2/users/{email}?type=email

Path Parameters

Parameter Type Validations
email string, required Email address of the User account to retrieve from the system.

Response Body

Successful response

{
"userId": "9184c0a8-a91e-43e3-8a5c-e151a12b2db8",
"firstname": "Content",
"lastname": "Viewer",
"language": null,
"username": "contentviewer",
"email": "douguhlcontentviewer@portal.vbrick.com",
"title": null,
"phone": null,
"groups": {
"id": "9cb1b1dd-7522-4468-8183-1881eed77d77",
"name": "Bank of North Dakota"
},
"teams": {
"id": "ceecd975-9972-4e5b-9556-ff83135cc06e",
"name": "North Dakota"
},
"roles": {
"id": "06efae78-ff33-4325-bbb3-6ecf973b2566",
"name": "MediaViewer"
}
}

 

Unauthorized error

Internal server error