Lister les personnes avec l'API Conta Azul

Liste les personnes de l'entreprise, c'est-à-dire ses clients, fournisseurs et transporteurs, avec filtre optionnel par texte, profil ou type. La réponse contient items et totalItems ; paginez avec pagina, et une page plus courte que tamanho_pagina est la dernière.

Identifiant
conta_azul_list_people

L'appel

POST https://connect.reportei.com/api/tools/conta_azul_list_people/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "busca": "<busca>"
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
buscastringNonText to search in the name or in the CPF or CNPJ.
tipo_perfilstringNonOnly the people with this profile: Cliente (customer), Fornecedor (supplier) or Transportadora (carrier).Valeurs : Cliente, Fornecedor, Transportadora
tipos_pessoastringNonOnly the people of this type: Física (individual), Jurídica (company) or Estrangeira (foreign).Valeurs : Física, Jurídica, Estrangeira
paginaintegerNonPage number, starting at 1. The default is 1.
tamanho_paginaintegerNonPeople per page. The default is 10.Valeurs : 10, 20, 50, 100, 200, 500, 1000

Connexions possibles

Votre client connecte son compte Conta Azul une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/conta_azul, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/conta_azul_list_people. Il devient la définition de tool de votre agent sans conversion.

Autres tools Conta Azul

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.