Lister les objets avec l'API folk

Liste les deals, ou les objets d'un autre type, d'un groupe, avec id, nom, personnes et entreprises liées et valeurs des champs personnalisés, comme le Status du deal. La page suivante vient du curseur dans pagination.nextLink ; la dernière page n'a pas de nextLink. Un objectType inconnu répond 404 avec les types d'objet du groupe.

Identifiant
folk_list_objects

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "groupId": "<groupId>",
    "objectType": "<objectType>"
  }
}

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
groupIdstringOuiId of the group, starting with grp_, from List groups.
objectTypestringOuiName of the object type exactly as shown in folk, case-sensitive and with its spaces: Deals for deals, or another objectField name from List group custom fields.
limitintegerNonResults per page, up to 100. Defaults to 20.
cursorstringNonThe cursor value inside pagination.nextLink of the previous response, URL-decoded (%3D becomes =). Omit it on the first call.

Connexions possibles

Votre client connecte son compte folk 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/folk_list_objects. Il devient la définition de tool de votre agent sans conversion.

Autres tools folk

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.