View Categories

Get user by user name.

< 1 min read

GET/user/{username}

Code Samples #

  • 💻 cURL
  • 📄 JavaScript
  • 🐍 Python
  • 🐘 PHP
  • 🔷 C#
  • Java
Copy
curl --request GET \
  --url '/api/v3/user/{username}'

Get user detail based on username.

Path Parameters #

NameTypeRequiredDescription
usernamestringRequiredThe name that needs to be fetched. Use user1 for testing

Responses #

200 — successful operation #

FieldTypeRequiredDescription
idinteger (int64)Optional
usernamestringOptional
firstNamestringOptional
lastNamestringOptional
emailstringOptional
passwordstringOptional
phonestringOptional
userStatusinteger (int32)OptionalUser Status
📋
Example 200 response
Copy
{
    "id": 10,
    "username": "theUser",
    "firstName": "John",
    "lastName": "James",
    "email": "john@email.com",
    "password": "12345",
    "phone": "12345",
    "userStatus": 1
}

400 — Invalid username supplied #

404 — User not found #

default — Unexpected error #

Response #

200
{
    "id": 10,
    "username": "theUser",
    "firstName": "John",
    "lastName": "James",
    "email": "john@email.com",
    "password": "12345",
    "phone": "12345",
    "userStatus": 1
}

Powered by BetterDocs

Leave a Reply

Your email address will not be published. Required fields are marked *

This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.