Nixiesearch API

Get user by user name

GET /user/{username}

Path parameters

  • username string Required

    The name that needs to be fetched. Use user1 for testing.

Responses

  • 200

    successful operation

    Hide response attributes Show response attributes object
    • id integer(int64)
    • username string
    • firstName string
    • lastName string
    • email string
    • password string
    • phone string
    • userStatus integer(int32)

      User Status

    Hide response attributes Show response attributes object
    • id integer(int64)
    • username string
    • firstName string
    • lastName string
    • email string
    • password string
    • phone string
    • userStatus integer(int32)

      User Status
  • 400

    Invalid username supplied

  • 404

    User not found

GET /user/{username} 
curl \
 --request GET '/api/v3/user/{username}'
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <id type="integer">10</id>
  <username>theUser</username>
  <firstName>John</firstName>
  <lastName>James</lastName>
  <email>john@email.com</email>
  <password>12345</password>
  <phone>12345</phone>
  <userStatus type="integer">1</userStatus>
</root>
Response examples (200) 
{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": "12345",
  "phone": "12345",
  "userStatus": 1
}