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

# Listar Contatos

> Use este endpoint para listar todos os contatos do usuário autenticado.



## OpenAPI

````yaml api-reference/openapi.json get /contacts
openapi: 3.1.0
info:
  title: Noodle API
  contact:
    name: Time de Engenharia da Noodle
    url: https://www.noodle.cx/contato
    email: dev@noodle.cx
  version: 1.0.0
servers:
  - url: https://production.api.noodle.cx/external
    description: Servidor de Produção
  - url: https://homolog.api.noodle.cx/external
    description: Servidor de Homologação (Staging)
security: []
paths:
  /contacts:
    get:
      tags:
        - Contatos
      summary: Listar Contatos
      description: Use este endpoint para listar todos os contatos do usuário autenticado.
      operationId: list_contacts_contacts_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ContactModel'
                type: array
                title: Response List Contacts Contacts Get
      security:
        - APIKeyHeader: []
components:
  schemas:
    ContactModel:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: Identificador único do contato.
        tax_id:
          type: string
          title: Tax Id
          description: CPF ou CNPJ do contato.
        tax_id_manager:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Id Manager
          description: CPF ou CNPJ do gestor que cadastrou o contato.
        name:
          type: string
          title: Name
          description: Nome do contato.
        email:
          type: string
          title: Email
          description: Endereço de e-mail do contato.
        has_bank_account:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Has Bank Account
          description: Indica se o contato possui conta bancária cadastrada.
          default: false
        accounts:
          anyOf:
            - items:
                $ref: '#/components/schemas/ContactAccountModel'
              type: array
            - type: 'null'
          title: Accounts
          description: Lista de contas bancárias associadas ao contato.
      type: object
      required:
        - tax_id
        - name
        - email
      title: ContactModel
      description: >-
        Representa os dados de um contato na agenda.


        **Atributos**:

        - **id** (*str, opcional*): Identificador único do contato.

        - **tax_id** (*str*): CPF ou CNPJ do contato.

        - **tax_id_manager** (*str, opcional*): CPF ou CNPJ do gestor que
        cadastrou o contato.

        - **name** (*str*): Nome do contato.

        - **email** (*str*): Endereço de e-mail do contato.

        - **has_bank_account** (*bool, opcional*): Indica se o contato possui
        conta bancária cadastrada.

        - **accounts** (*list[ContactAccountModel], opcional*): Lista de contas
        bancárias associadas ao contato.
    ContactAccountModel:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: Identificador único da conta.
        bank_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Name
          description: Nome do banco.
        bank_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Code
          description: Código do banco.
        bank_ispb:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Ispb
          description: Código ISPB do banco.
        agency:
          anyOf:
            - type: string
            - type: 'null'
          title: Agency
          description: Número da agência bancária.
        account_number:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Number
          description: Número da conta bancária.
        account_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Account Type
          description: 'Tipo da conta (ex: Corrente, Poupança).'
        pix_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Pix Key
          description: Chave PIX associada à conta.
        pix_key_type:
          anyOf:
            - type: string
            - type: 'null'
          title: Pix Key Type
          description: 'Tipo da chave PIX (ex: CPF, Email, Telefone).'
        tax_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Id
          description: CPF ou CNPJ do titular da conta.
        tax_id_manager:
          anyOf:
            - type: string
            - type: 'null'
          title: Tax Id Manager
          description: CPF ou CNPJ do gestor que cadastrou a conta.
        contact_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact Id
          description: ID do contato ao qual a conta pertence.
        is_favorite:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Favorite
          description: Indica se a conta é a favorita do contato.
          default: false
      type: object
      title: ContactAccountModel
      description: >-
        Representa os dados da conta bancária de um contato.


        **Atributos**:

        - **id** (*str, opcional*): Identificador único da conta.

        - **bank_name** (*str, opcional*): Nome do banco.

        - **bank_code** (*str, opcional*): Código do banco.

        - **bank_ispb** (*str, opcional*): Código ISPB do banco.

        - **agency** (*str, opcional*): Número da agência bancária.

        - **account_number** (*str, opcional*): Número da conta bancária.

        - **account_type** (*str, opcional*): Tipo da conta (ex: Corrente,
        Poupança).

        - **pix_key** (*str, opcional*): Chave PIX associada à conta.

        - **pix_key_type** (*str, opcional*): Tipo da chave PIX (ex: CPF, Email,
        Telefone).

        - **tax_id** (*str, opcional*): CPF ou CNPJ do titular da conta.

        - **tax_id_manager** (*str, opcional*): CPF ou CNPJ do gestor que
        cadastrou a conta.

        - **contact_id** (*str, opcional*): ID do contato ao qual a conta
        pertence.

        - **is_favorite** (*bool, opcional*): Indica se a conta é a favorita do
        contato.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.