Get a user by username | Sample - Swagger Petstore OpenAPI 3

1 parameter

usernamestringrequired

The username of the user to retrieve.

4 status codes

200Returns the matching user object with identity, contact, credential, and account-status fields.

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`.

defaultReturned when an unexpected error occurs.

Error handling

A 400 is returned when username is invalid. A 404 is returned when no user exists for the supplied username, so use a username that identifies an existing user.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { apiKey: process.env.API_KEY },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

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