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

# List contacts

> List registered contacts.



## OpenAPI

````yaml /en/contacts-api/api-reference/openapi-contacts.json get /v1/contacts
openapi: 3.0.3
info:
  title: Notifique API Contatos, tags e audiência
  description: >-
    API para **CRUD de contatos**, **tags**, **tópicos**, **segmentos** e
    **campanhas** (template + audiência + canais).


    **Contato:** pelo menos um de **phone** ou **email** (únicos por workspace).
    **Idiomas:** `languages` é um array de códigos BCP-47 permitidos (lista em
    **`GET /v1/meta/contact-locales`**); ordem = prioridade. **Telegram:** use
    **`telegramLinks`** (`instanceId` + `peer`) para várias instâncias Telegram
    no mesmo workspace; **`telegramPeer`** permanece como atalho legado
    (preenche a ligação na **instância Telegram padrão** do workspace). Na
    campanha, o peer usado é o da **`telegramInstanceId`** da campanha (ou
    default), com *fallback* para `telegramPeer`.


    **Campanhas:** `channels` pode incluir `whatsapp`, `sms`, `email`,
    `telegram`. Cada canal listado deve estar **habilitado no template**.
    **`instanceId`** = WhatsApp; **`telegramInstanceId`** = Telegram.


    **WhatsApp cartão:** `POST /v1/whatsapp/messages` com `type: "contact"` e
    `payload.contactId`.


    **Autenticação:** `Authorization: Bearer sk_live_xxxxx` ou `x-api-key`.


    **Escopos:** `contacts:*`, `tags:*`, `topics:*`, `segments:*`, `campaigns:*`
    (inclui `campaigns:run`).


    **Campaign extras:** `POST .../cancel` (DRAFT/SCHEDULED), `GET .../stats`
    and `GET .../recipients` (update/read scopes). Run returns `runId`. WhatsApp
    Sending Pool: dashboard.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfContactBearerAuth: []
  - ntfContactApiKeyHeader: []
tags:
  - name: Contatos
    description: CRUD de contatos do workspace (phone ou email; tags)
  - name: Tags
    description: Tags (rótulos) para vincular a contatos
  - name: Tópicos
    description: Tópicos de comunicação (marketing / opt-in por tema)
  - name: Segmentos
    description: >-
      Segmentos de audiencia (DSL v1). Regras: tag, property, contactField,
      topic, receiveMarketing. Escopos segments:read|create|update|delete.
  - name: Campanhas
    description: Campanhas multicanal com template; execução via POST .../run
paths:
  /v1/contacts:
    get:
      tags:
        - Contatos
      summary: List contacts
      description: List registered contacts.
      operationId: ntfContact_getV1Contacts
      parameters:
        - name: page
          in: query
          schema:
            type: string
          description: Página (default 1)
        - name: limit
          in: query
          schema:
            type: string
          description: Itens por página (default 20, máx 100)
        - name: search
          in: query
          schema:
            type: string
          description: Busca por nome, telefone ou e-mail
        - name: tagId
          in: query
          schema:
            type: string
          description: Filtrar contatos que têm esta tag
      responses:
        '200':
          description: Lista de contatos e paginação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NtfContact_Contact'
                  pagination:
                    type: object
                    properties:
                      total:
                        type: integer
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '402':
          description: Plano expirado ou suspenso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
        '403':
          description: Escopo contacts:read ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
components:
  schemas:
    NtfContact_Contact:
      type: object
      description: >-
        Contato do workspace (phone e/ou email; tags). **telegramLinks** por
        instância Telegram; **telegramPeer** espelha o peer na instância padrão
        (legado).
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
          description: Telefone com código do país
        email:
          type: string
          nullable: true
        telegramPeer:
          type: string
          nullable: true
          description: >-
            Espelho do peer na instância Telegram padrão; preferir telegramLinks
            para múltiplas conexões.
        languages:
          type: array
          items:
            type: string
          description: Códigos BCP-47 permitidos; ordem = prioridade do idioma preferido.
        receiveMarketing:
          type: boolean
        telegramLinks:
          type: array
          items:
            $ref: '#/components/schemas/NtfContact_TelegramLink'
        url:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        tags:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
    NtfContact_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: HTTP-style error label (e.g. Unauthorized, Bad Request, Not Found).
        message:
          type: string
          description: >-
            Human-readable message for end users (localized via Accept-Language
            / x-locale when applicable).
        code:
          type: string
          description: >-
            Stable API v1 code (enum). Always present on errors. Use with the
            HTTP status to decide retry or fix. See [Error
            responses](/en/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfContact_TelegramLink:
      type: object
      description: Ligação do contato a uma instância Telegram do workspace.
      properties:
        instanceId:
          type: string
        peer:
          type: string
          description: chat_id ou @username nesta instância
        instanceName:
          type: string
          description: Nome da instância (conexão)
  securitySchemes:
    ntfContactBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfContactApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-key: sk_live_xxxxx'

````