Lister les lignes avec l'API Superhuman Docs
Liste les lignes d'une table ou vue, de la plus ancienne à la plus récente sauf si sortBy dit autre chose, avec id, name et les valeurs indexées par id de colonne. Les données peuvent avoir quelques secondes de retard.
- Identifiant
- coda_list_rows
L'appel
POST https://connect.reportei.com/api/tools/coda_list_rows/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"docId": "<docId>",
"tableIdOrName": "<tableIdOrName>"
}
}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 |
|---|---|---|---|
| docId | string | Oui | Id of the doc, from List docs. |
| tableIdOrName | string | Oui | Id of the table or view, from List tables. A name also works, but names change. |
| query | string | Non | Filter on one column: the column id from List columns, or its name in double quotes, then a colon and a JSON value, such as "Status":"Done" or c-tuVwxYz:42. Text values go in double quotes. |
| sortBy | string | Non | createdAt, the default, brings the oldest first; updatedAt orders by the last edit; natural follows the order shown in the table and returns only visible rows.Valeurs : createdAt, natural, updatedAt |
| useColumnNames | boolean | Non | true keys the values by column name instead of id. |
| valueFormat | string | Non | simple, the default, returns plain values, with lists as comma-separated text; simpleWithArrays returns lists as arrays; rich adds Markdown to text and structure to currency, lookup, image, person and link values.Valeurs : simple, simpleWithArrays, rich |
| visibleOnly | boolean | Non | true returns only the visible rows and columns. |
| limit | integer | Non | Rows per page. The default is 25. |
| pageToken | string | Non | The nextPageToken of the previous response. |
Connexions possibles
Votre client connecte son compte Superhuman Docs 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/coda_list_rows. Il devient la définition de tool de votre agent sans conversion.
Autres tools Superhuman Docs
- Lister les docsGETListe les docs auxquels l'utilisateur peut accéder et qu'il a ouverts au moins une fois, du plus récent au plus ancien, avec id, name, owner, workspace et browserLink. Envoyez nextPageToken comme pageToken pour la page suivante.
- Créer un docPOSTCrée un doc, vide ou copie d'un autre, dans le dossier My docs du plus ancien workspace de l'utilisateur. Exige le rôle Doc Maker dans le workspace.
- Lister les pagesGETListe les pages d'un doc avec id, name, subtitle, parent et children. Envoyez nextPageToken comme pageToken pour la page suivante.
- Lister le contenu d'une pageGETRenvoie le contenu d'une page en texte brut, élément par élément. Envoyez nextPageToken comme pageToken pour la partie suivante.
- Créer une pagePOSTCrée une page dans un doc, ou une sous-page, avec du contenu en Markdown ou HTML. Le changement est mis en file et apparaît en quelques secondes ; la réponse contient l'id de la page.
- Mettre à jour une pagePUTRenomme une page ou y ajoute du contenu, à la fin, au début ou en remplaçant tout. Le changement est mis en file et apparaît en quelques secondes.
- Lister les tablesGETListe les tables et vues d'un doc avec id, name, type et la page parente. Les lignes ne s'écrivent que dans les tables, pas dans les vues.
- Lister les colonnesGETListe les colonnes d'une table avec id, name et format. Les ids de colonnes vont dans les cells de Créer des lignes et Mettre à jour une ligne, et dans la query de Lister les lignes.
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.
