Get a user by username | Swagger Petstore

1 parameter

usernamestringrequired

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

4 status codes

200Returns the user object, including its identifier, username, name, email, password, phone, and status.

idintegeroptional

usernamestringoptional

firstNamestringoptional

lastNamestringoptional

emailstringoptional

passwordstringoptional

phonestringoptional

userStatusintegeroptional

User Status

400Returned when the supplied username is invalid.

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

defaultReturned when an unexpected error occurs.

Error handling

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

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

const client = new Client({
  baseUrl: "/api/v3",
  auth: { bearer: process.env.API_TOKEN },
});

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