GET/user/{username}

Retrieve a user by username

Retrieves a user by the user's username. Supply username to fetch the matching user details, including account, contact, and status information.

1 parameter
usernamestringrequired

The username of the user to retrieve.

4 status codes
200Returns the matching user object with its identifier, username, personal details, contact information, and status.
idintegeroptional
usernamestringoptional
firstNamestringoptional
lastNamestringoptional
emailstringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

400Returned when the supplied username is invalid.
404Returned when no user exists with the supplied username.
defaultUnexpected error

Error handling

A 400 is returned when username is invalid. A 404 is returned when no user exists with the supplied username.