Get user details by username

1 parameter

usernamestringrequired

The name of the user to retrieve.

4 status codes

200Returns the user object, including the user's account details.

emailstringoptional

firstNamestringoptional

idintegeroptional

lastNamestringoptional

passwordstringoptional

phonestringoptional

userStatusintegeroptional

User Status

usernamestringoptional

400Returned when the supplied username is invalid.

404Returned when no user is found with the supplied username.

defaultUnexpected error

Error handling

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

import { SwaggerPetstoreOpenAPI30 } from "t-sdk";

const client = new SwaggerPetstoreOpenAPI30({
  baseUrl: "/api/v3",
  auth: { apiKey: process.env.SWAGGER_PETSTORE_API_KEY! },
});

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

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

Request

Response

Errors