Skip to main content
GET
/
contacts
Listar Contatos
curl --request GET \
  --url https://production.api.noodle.cx/external/contacts \
  --header 'Authorization: <api-key>'
[
  {
    "tax_id": "<string>",
    "name": "<string>",
    "email": "<string>",
    "id": "<string>",
    "tax_id_manager": "<string>",
    "has_bank_account": false,
    "accounts": [
      {
        "id": "<string>",
        "bank_name": "<string>",
        "bank_code": "<string>",
        "bank_ispb": "<string>",
        "agency": "<string>",
        "account_number": "<string>",
        "account_type": "<string>",
        "pix_key": "<string>",
        "pix_key_type": "<string>",
        "tax_id": "<string>",
        "tax_id_manager": "<string>",
        "contact_id": "<string>",
        "is_favorite": false
      }
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Response

200 - application/json

Successful Response

​
tax_id
string
required

CPF ou CNPJ do contato.

​
name
string
required

Nome do contato.

​
email
string
required

Endereço de e-mail do contato.

​
id
string | null

Identificador único do contato.

​
tax_id_manager
string | null

CPF ou CNPJ do gestor que cadastrou o contato.

​
has_bank_account
boolean | null
default:false

Indica se o contato possui conta bancária cadastrada.

​
accounts
ContactAccountModel · object[] | null

Lista de contas bancárias associadas ao contato.