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

Search for a User by Username

Returns User details for an account by a provided Username.

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

Path Parameters

Parameter Type Validations
userName string, required Username of the User account to retrieve from the system.

Response Body

Successful response

{
"userId": "32346556-b91d-46f0-a370-786116536521",
"firstname": "John",
"lastname": "Smith",
"language": null,
"username": "john.smith",
"email": "john.smith@company.com",
"title": "Directory",
"phone": null,
"groups": [
{
"id": "94523458-1e5f-42d7-8765-abdfaa879bc4",
"name": "All Users"
} ],
"teams": [
{
"id": "270b4266-9ada-4029-8e25-d773kd93ld94",
"name": "Marketing"
} ],
"roles": [
{
"id": "79dbe154-f518-43dc-b60b-412e3d4f1c2f",
"name": "Media Admin"
} ]
}

Unauthorized error

Internal server error