Lister les fiches avec l'API Attio
Liste les fiches d'un objet, avec filtre et tris facultatifs. Chaque fiche contient id.record_id et ses valeurs indexées par le slug de l'attribut. Paginez avec limit, 500 par défaut, et offset.
- Identifiant
- attio_list_records
L'appel
POST https://connect.reportei.com/api/tools/attio_list_records/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"object": "<object>"
}
}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ètre | Type | Obligatoire | Description |
|---|---|---|---|
| object | string | Oui | api_slug of the object from List objects, such as people, companies or deals. |
| filter | object | Non | Filter keyed by attribute slug, in shorthand like {name: Acme} or verbose with operators such as $eq, $contains, $in, $not_empty, $and and $or. A person name is matched on name.full_name and an email on email_addresses.email_address. |
| sorts | array | Non | Sort order, first item first. |
| limit | integer | Non | Records per page. The default is 500. |
| offset | integer | Non | Records to skip, for the next page. |
Connexions possibles
Votre client connecte son compte Attio 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.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/attio, 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/attio_list_records. Il devient la définition de tool de votre agent sans conversion.
Autres tools Attio
- Lister les objetsGETListe les objets du workspace : les standard, comme people, companies et deals, et les personnalisés. Utilisez l'api_slug d'un élément comme object dans les outils de fiches et comme parent_object dans ceux des entrées et des notes.
- Lister les attributsGETListe les attributs d'un objet ou d'une liste, dans l'ordre de l'app, avec l'api_slug, le type et si chacun est obligatoire ou unique. Les slugs sont les clés de values et entry_values dans les autres outils et dans leurs filtres.
- Obtenir une ficheGETRenvoie une fiche avec toutes ses valeurs indexées par le slug de l'attribut et son web_url.
- Créer une fichePOSTCrée une fiche d'un objet, comme une personne, une entreprise ou un deal. Échoue lorsqu'un attribut unique, comme le domaine d'une entreprise ou l'e-mail d'une personne, appartient déjà à une autre fiche. Renvoie la nouvelle fiche avec id.record_id.
- Mettre à jour une fichePATCHMet à jour les attributs indiqués d'une fiche et laisse les autres inchangés. Les valeurs d'un attribut multiselect s'ajoutent à celles qu'il a déjà.
- Lister les listesGETListe les listes du workspace, comme les pipelines de vente, dans l'ordre de la barre latérale. Utilisez l'api_slug d'un élément comme list dans les outils d'entrées ; son parent_object indique de quel objet viennent ses fiches.
- Lister les entréesPOSTListe les entrées d'une liste, avec filtre et tris facultatifs sur les attributs de la liste, comme l'étape d'un pipeline. Chaque entrée a id.entry_id, parent_record_id et parent_object. Paginez avec limit, 500 par défaut, et offset.
- Créer une entrée de listePOSTAjoute une fiche à une liste comme nouvelle entrée, avec des valeurs pour les attributs de la liste, comme l'étape. La même fiche peut être ajoutée plusieurs fois. Renvoie l'entrée avec id.entry_id.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
