GET/user/{username}

Get a user by username

Retrieves a user account by username. Supply the username of the account whose details you want to retrieve.

1 parameter
usernamestringrequired

The username of the user to retrieve.

4 status codes
200Returns the user object, including its username, identifier, contact details, and status.
emailstringoptional
firstNamestringoptional
idintegeroptional
lastNamestringoptional
passwordstringoptional
phonestringoptional
userStatusintegeroptional

User Status

usernamestringoptional
400Returned when the supplied username is invalid.
404Returned when no user is found for the supplied username.
defaultUnexpected error

Error handling

A 400 is returned when the supplied username is invalid. A 404 is returned when no user is found for the username path parameter.