Get a user by username | Swagger Petstore

1 parameter

usernamestringrequired

The username of the user to retrieve; use user1 for testing.

4 status codes

200Returns the requested user object with its identifier, username, profile details, contact information, password, and status.

idintegeroptional

usernamestringoptional

firstNamestringoptional

lastNamestringoptional

emailstringoptional

passwordstringoptional

phonestringoptional

userStatusintegeroptional

User Status

400Returned when the supplied username is invalid.

404Returned when no user exists with the supplied username.

defaultUnexpected error

Error handling

A 400 is returned when username is invalid. A 404 is returned when no user exists for the supplied username, so the value must identify an existing user.

import { SwaggerPetstoreOpenAPI30 } from "swagger-petstore---openapi-3-0-sdk";

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

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

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

Request

Response

Errors