Get a user by username

1 parameter

usernamestringrequired

The username of the user to retrieve. Use user1 for testing.

4 status codes

200Returns the user object containing id, username, firstName, lastName, email, password, phone, and userStatus.

idintegeroptional

usernamestringoptional

firstNamestringoptional

lastNamestringoptional

emailstringoptional

passwordstringoptional

phonestringoptional

userStatusintegeroptional

User Status

400Returned when the username supplied is invalid or malformed.

404Returned when no user exists with the given username.

defaultUnexpected error

Error handling

username is required and must identify an existing user. A 400 is returned if the username format is invalid. A 404 is returned if no user exists with the given username.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.user.get({ username: "octocat" });

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

Request

Response

Errors