> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter Informações Básicas do Contato

> Obter informações básicas de contatos do WhatsApp

## Descrição

Este endpoint permite obter informações básicas de contatos no WhatsApp. Você pode buscar um contato específico informando o JID ou listar múltiplos contatos usando paginação.

## Query Parameters

<ParamField query="sessionId" type="string" required>
  ID da sessão autenticada
</ParamField>

<ParamField query="jid" type="string" optional>
  Identificador do contato (JID do WhatsApp). Se informado, retorna apenas o contato específico. Formato: `5511999999999@s.whatsapp.net`
</ParamField>

<ParamField query="limit" type="number" optional default="100">
  Limite de contatos retornados (padrão: 100)
</ParamField>

<ParamField query="offset" type="number" optional default="0">
  Offset para paginação (padrão: 0)
</ParamField>

<ResponseExample>
  ```json Resposta de Sucesso theme={null}
  {
    "contacts": [
      {
        "jid": "5511999999999@s.whatsapp.net",
        "name": "João Silva",
        "notify": "João",
        "verifiedName": "João Silva",
        "businessName": ""
      }
    ]
  }
  ```
</ResponseExample>

## Códigos de Status

* `200` - Contatos retornados com sucesso
* `400` - Parâmetros inválidos
* `401` - Sessão não autorizada
* `404` - Sessão não encontrada

## Exemplo de Uso

<CodeGroup>
  ```bash cURL theme={null}
  # Obter contato específico
  curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&jid=5511999999999@s.whatsapp.net"

  # Listar contatos com paginação
  curl -X GET "https://api.wappfy.com.br/api/contacts?sessionId=my-session&limit=50&offset=0"
  ```

  ```javascript JavaScript theme={null}
  // Obter contato específico
  const sessionId = 'my-session';
  const jid = '5511999999999@s.whatsapp.net';
  const response = await fetch(
    `https://api.wappfy.com.br/api/contacts?sessionId=${sessionId}&jid=${jid}`
  );
  const data = await response.json();
  console.log(data);

  // Listar contatos com paginação
  const response2 = await fetch(
    `https://api.wappfy.com.br/api/contacts?sessionId=${sessionId}&limit=50&offset=0`
  );
  const data2 = await response2.json();
  console.log(data2);
  ```

  ```python Python theme={null}
  import requests

  # Obter contato específico
  session_id = 'my-session'
  jid = '5511999999999@s.whatsapp.net'
  response = requests.get(
      'https://api.wappfy.com.br/api/contacts',
      params={
          'sessionId': session_id,
          'jid': jid
      }
  )
  data = response.json()
  print(data)

  # Listar contatos com paginação
  response2 = requests.get(
      'https://api.wappfy.com.br/api/contacts',
      params={
          'sessionId': session_id,
          'limit': 50,
          'offset': 0
      }
  )
  data2 = response2.json()
  print(data2)
  ```
</CodeGroup>


## OpenAPI

````yaml viewer.json get /api/contacts
openapi: 3.1.0
info:
  title: Wappfy - WhatsApp HTTP API
  version: '2.0'
  contact: {}
servers:
  - url: https://{host}
    description: Servidor Customizável
    variables:
      host:
        default: api.wappfy.com.br
        description: 'URL do servidor (ex: api.wappfy.com.br ou seu-servidor.com)'
security:
  - api_key: []
tags:
  - name: 🖥️ Sessions
    description: >-
      Controlar sessões do WhatsApp (contas) (Control WhatsApp sessions
      (accounts))
  - name: 🔑 Auth
    description: Autenticação
  - name: 🆔 Profile
    description: Informações do seu perfil
  - name: 🖼️ Screenshot
    description: Obter captura de tela do WhatsApp e mostrar código QR
  - name: 📤 Chatting
    description: Métodos de conversação
  - name: 📢 Channels
    description: Métodos de canais (newsletters) (Channels (newsletters) methods)
  - name: 🟢 Status
    description: Métodos de status (aka stories) (Status (aka stories) methods)
  - name: 💬 Chats
    description: Métodos de conversas
  - name: 👤 Contacts
    description: >-
      Métodos de contatos. Use número de telefone (sem +) ou número de telefone
      e `@c.us` no final como `contactId`. Ex: `12312312310` OU
      `12312312310@c.us` (Contacts methods.<br>
                      Use phone number (without +) or phone number and `@c.us` at the end as `contactId`.<br>
                      'E.g: `12312312310` OR `12312312310@c.us`<br>)
  - name: 👥 Groups
    description: Métodos de grupos (Groups methods).<br>
  - name: ✅ Presence
    description: Informações de presença
  - name: 📅 Events
    description: Mensagem de Evento
  - name: 🏷️ Labels
    description: Etiquetas - disponível apenas para contas WhatsApp Business
  - name: 🔍 Observability
    description: Outros métodos
  - name: 🗄️ Storage
    description: Métodos de armazenamento
externalDocs:
  description: Wappfy - WhatsApp HTTP API
  url: https://wappfy.com.br/
paths:
  /api/contacts:
    get:
      tags:
        - 👤 Contacts
      summary: Obter informações básicas do contato
      description: >-
        O método sempre retorna resultado, mesmo se o número de telefone não
        estiver registrado no WhatsApp. Para isso - use o endpoint
        /contacts/check-exists abaixo
      operationId: ContactsController_get
      parameters:
        - name: contactId
          required: true
          in: query
          example: 5511999999999@c.us
          schema:
            type: string
      responses:
        '200':
          description: ''
      security:
        - api_key: []
components:
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: apikey
      description: Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

````