Lister les personnes avec l'API Agendor

Liste et recherche les personnes du compte, 10 par page par défaut, dans data, avec meta.totalCount et la page suivante dans links.next.

Identifiant
agendor_list_people

L'appel

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

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

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
namestringNonBeginning of the name.
emailstringNonBeginning of the email address.
cpfstringNonBeginning of the CPF.
phonestringNonNumber searched in every phone field.
organizationintegerNonId of an organization, from List organizations, to return its people.
userOwnerintegerNonId of the user who owns the people, from List users.
statestringNonState abbreviation of the address.Valeurs : AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO
createdAtGtstringNonReturns people created after this date and time, in ISO 8601.
updatedAtGtstringNonReturns people updated after this date and time, in ISO 8601.
withCustomFieldsbooleanNontrue includes the custom fields of each person.
pageintegerNonPage number, starting at 1.
per_pageintegerNonPeople per page, up to 100. The default is 10.

Connexions possibles

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

Clé d'API

Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.

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/agendor_list_people. Il devient la définition de tool de votre agent sans conversion.

Autres tools Agendor

Voir les 15 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.