# Obter @username

`GET /instance/username`

Pasta: **Instancia**

## Autenticação

```http
token: {{token}}
```

## Descrição

# Obter @username

Retorna o @username da conta (se reservado), status e alias vinculado via WAPI.

Funciona em companion e mobile (usa o cliente WhatsApp unificado).

## Endpoint

```http
GET {{baseUrl}}/instance/username
```

## Autenticação

Header da instância:

```http
token: {{token}}
```

## Exemplo de Requisição

```bash
curl -X GET "{{baseUrl}}/instance/username" \
  -H "token: {{token}}"
```

## Resposta de Sucesso

```json
{
  "success": true,
  "username": {
    "username": "minhaempresa",
    "status": "available",
    "linked_alias": ""
  }
}
```

## Erros comuns

- `401` — header `token` ausente ou inválido
- `500` — sessão não conectada / bridge indisponível

## cURL

```bash
curl -X GET "{{baseUrl}}/instance/username" \
  -H "token: {{token}}"
```

---

[Índice da pasta](./index.md) · [Índice geral](../index.md) · [UI](https://gozap.dev/docs?op=instancia/obter-username)