Lister les personnes avec l'API Teamwork.com

Liste les personnes du site avec leurs ids, que prennent les arguments assignee et user, et leurs e-mails. Paginez avec page, à partir de 1, tant que meta.page.hasMore dans la réponse est true.

Identifiant
teamwork_list_people

L'appel

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

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

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
searchTermstringNonText to search people by.
userTypestringNonOnly people of this type.Valeurs : account, collaborator, contact, client
includeClientsbooleanNonTrue to include the people of client companies.
orderBystringNonField to sort by.Valeurs : name, company, dateupdated
orderModestringNonSort order.Valeurs : asc, desc
pageintegerNonPage to fetch, starting at 1.
pageSizeintegerNonItems per page, 50 by default and up to 500.

Connexions possibles

Votre client connecte son compte Teamwork.com 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/teamwork, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

À la connexion, votre client indique aussi {site} : l'adresse de son compte sur l'API de l'app.

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

Autres tools Teamwork.com

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.