Lister les clients avec l'API Clockify

Liste les clients d'un workspace, 50 par page. Une page de moins de 50 clients est la dernière.

Identifiant
clockify_list_clients

L'appel

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

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

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
workspaceIdstringOuiId of the workspace, from List workspaces or the activeWorkspace of Get current user.
namestringNonOnly clients whose name contains this text.
archivedstringNontrue for archived clients only, false for active ones only. Leave it out for both.
pageintegerNonPage to fetch, starting at 1. Pages have 50 items, and a page with fewer is the last one.

Connexions possibles

Votre client connecte son compte Clockify 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 connexion, votre client indique aussi {region} : 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/clockify_list_clients. Il devient la définition de tool de votre agent sans conversion.

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.