---
title: "Get nickname for a phone number"
method: GET
path: "/nickname"
tags: ["Phone Numbers (Unlimited)"]
---

# Get nickname for a phone number

`GET /nickname`

## Request

- Base URL: `https://api.quackr.io`
- URL: `https://api.quackr.io/nickname`
- Auth: API key in header `x-api-key`

Retrieve the nickname associated with a specific phone number

## Query parameters

- `phoneNumber` string, required

## Response `200`

Successfully retrieved nickname

- object
  - `success` boolean
  - `phoneNumber` string
  - `nickname` string

## Other responses

- `400`: Invalid phone number format

---

[API](https://skmtc.dev/quackr/apis/quackr-api.md) · [All operations](https://skmtc.dev/quackr/apis/quackr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/quackr/apis/quackr-api/revisions/9b7240306750?raw)