---
title: "Username suggestion and availability check"
method: POST
path: "/user/username-suggestions"
tags: ["Username Suggestion and availability"]
---

# Username suggestion and availability check

`POST /user/username-suggestions`

## Request body

- UsernameSuggestionPayload
  - `sFirstName` string
  - `sLastName` string
  - `sUsername` string

## Response `200`

Username suggestions and availability check

- UsernameSuggestionResponse
  - `available` boolean, required — Whether or not the username is available on the system
  - `username` string, required — The username the user selected
  - `suggestions` string[]

## Other responses

- `400` — Username suggestions and availability check
- `default` — unexpected error

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) · [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/staffshift/staffshift-api-gateway/revisions/6e2cb83db3a9/schema)