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

# Search Contacts

> Pesquisar os contatos resolvidos usando uma chave de pesquisa, atualmente suporta pesquisa de e-mail (Tamanho da página = 15). Contatos resolvidos são aqueles com um valor de identificador, e-mail ou número de telefone



## OpenAPI

````yaml /pt-br/swagger/tag_groups/application_swagger.json get /api/v1/accounts/{account_id}/contacts/search
openapi: 3.1.0
info:
  title: Chatwoot
  description: Esta é a documentação da API para o servidor Chatwoot.
  version: 1.1.0
  termsOfService: https://www.chatwoot.com/terms-of-service/
  contact:
    email: hello@chatwoot.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://airys.chat/
security: []
tags:
  - name: AgentBots de Conta
    description: Agent Bots específicos da conta
  - name: Agentes
    description: APIs de gerenciamento de agentes
  - name: Respostas Prontas
    description: Respostas predefinidas para consultas comuns
  - name: Contatos
    description: APIs de gerenciamento de contatos
  - name: Rótulos de Contato
    description: Gerenciar rótulos de contato
  - name: Atribuições de Conversa
    description: Gerenciar atribuições de conversas
  - name: Rótulos de Conversa
    description: Gerenciar rótulos de conversas
  - name: Conversas
    description: APIs de gerenciamento de conversas
  - name: Atributos Personalizados
    description: Campos personalizados para contatos e conversas
  - name: Filtros Personalizados
    description: Filtros salvos para conversas
  - name: Caixas de Entrada
    description: Configuração de canais de comunicação
  - name: Integrações
    description: Integrações de terceiros
  - name: Rótulos
    description: APIs de gerenciamento de rótulos da conta
  - name: Mensagens
    description: APIs de gerenciamento de mensagens
  - name: Perfil
    description: APIs de perfil de usuário
  - name: Relatórios
    description: APIs de análise e relatórios
  - name: Equipes
    description: APIs de gerenciamento de equipe
  - name: Webhooks
    description: Webhooks de notificação de eventos
  - name: Regra de Automação
    description: Regras de automação de fluxo de trabalho
  - name: Central de Ajuda
    description: Gerenciamento da base de conhecimento
paths:
  /api/v1/accounts/{account_id}/contacts/search:
    get:
      tags:
        - Contatos
      summary: Search Contacts
      description: >-
        Pesquisar os contatos resolvidos usando uma chave de pesquisa,
        atualmente suporta pesquisa de e-mail (Tamanho da página = 15). Contatos
        resolvidos são aqueles com um valor de identificador, e-mail ou número
        de telefone
      operationId: contactSearch
      parameters:
        - $ref: '#/components/parameters/account_id'
        - name: q
          in: query
          schema:
            type: string
          description: >-
            Pesquise usando `name`, `identifier`, `email` ou `phone number` do
            contato
        - $ref: '#/components/parameters/contact_sort_param'
        - $ref: '#/components/parameters/page'
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/contacts_list_response'
        '401':
          description: Erro de autenticação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request_error'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: account_id
      schema:
        type: integer
      required: true
      description: O ID numérico da conta
    contact_sort_param:
      in: query
      name: sort
      schema:
        type: string
        enum:
          - name
          - email
          - phone_number
          - last_activity_at
          - '-name'
          - '-email'
          - '-phone_number'
          - '-last_activity_at'
      required: false
      description: O atributo pelo qual a lista deve ser ordenada
    page:
      in: query
      name: page
      schema:
        type: integer
        default: 1
      required: false
      description: O parâmetro da página
  schemas:
    contacts_list_response:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/contact_meta'
        payload:
          type: array
          items:
            $ref: '#/components/schemas/contact_list_item'
          description: Lista de contatos
    bad_request_error:
      title: data
      type: object
      properties:
        description:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/request_error'
    contact_meta:
      type: object
      properties:
        count:
          type: integer
          description: Número total de contatos
        current_page:
          type:
            - string
            - integer
          description: Número da página atual
    contact_list_item:
      type: object
      properties:
        additional_attributes:
          type: object
          description: O objeto contendo atributos adicionais relacionados ao contato
          properties:
            city:
              type: string
              description: Cidade do contato
            country:
              type: string
              description: País do contato
            country_code:
              type:
                - string
                - 'null'
              description: Código do país do contato
            created_at_ip:
              type: string
              description: Endereço IP de quando o contato foi criado
        availability_status:
          type: string
          description: Status de disponibilidade do contato
          enum:
            - online
            - offline
        email:
          type:
            - string
            - 'null'
          description: O endereço de e-mail do contato
        id:
          type: integer
          description: O ID do contato
        name:
          type: string
          description: O nome do contato
        phone_number:
          type:
            - string
            - 'null'
          description: O número de telefone do contato
        blocked:
          type: boolean
          description: Se o contato está bloqueado
        identifier:
          type:
            - string
            - 'null'
          description: O identificador do contato
        thumbnail:
          type: string
          description: A miniatura do contato
        custom_attributes:
          type: object
          description: Os atributos personalizados do contato
        last_activity_at:
          type:
            - integer
            - 'null'
          description: Timestamp da última atividade
        created_at:
          type: integer
          description: Timestamp de quando o contato foi criado
        contact_inboxes:
          type: array
          description: Lista de caixas de entrada associadas a este contato
          items:
            $ref: '#/components/schemas/contact_inbox'
    request_error:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        code:
          type: string
    contact_inbox:
      type: object
      properties:
        source_id:
          type: string
          description: Identificador de origem para a caixa de entrada do contato
        inbox:
          type: object
          properties:
            id:
              type: integer
              description: ID da caixa de entrada
            avatar_url:
              type: string
              description: URL do avatar da caixa de entrada
            channel_id:
              type: integer
              description: ID do canal
            name:
              type: string
              description: Nome da caixa de entrada
            channel_type:
              type: string
              description: Tipo de canal
            provider:
              type:
                - string
                - 'null'
              description: Provedor da caixa de entrada
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Este token pode ser obtido visitando a página de perfil ou por meio do
        console rails. Fornece acesso a endpoints com base nos níveis de
        permissões do usuário. Este token pode ser salvo por um sistema externo
        quando o usuário é criado via API, para realizar atividades em nome do
        usuário.

````