List clients with the Clockify API
Lists the clients of a workspace, 50 per page. A page with fewer than 50 clients is the last one.
- Identifier
- clockify_list_clients
The request
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>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | Yes | Id of the workspace, from List workspaces or the activeWorkspace of Get current user. |
| name | string | No | Only clients whose name contains this text. |
| archived | string | No | true for archived clients only, false for active ones only. Leave it out for both. |
| page | integer | No | Page to fetch, starting at 1. Pages have 50 items, and a page with fewer is the last one. |
Supported connections
Your customer connects their Clockify account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
When connecting, your customer also enters {region}: the address of their account on the app's API.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/clockify_list_clients. It becomes your agent's tool definition with no conversion.
Other Clockify tools
- Get current userGETReturns the connected user with their id, which the userId arguments take, the ids of the active and default workspaces, the email and settings such as the timezone.
- List workspacesGETLists the workspaces of the connected user, with their ids, names, currencies and rates.
- List usersGETLists the users of a workspace with their ids, names and emails, 50 per page. A page with fewer than 50 users is the last one.
- Create clientPOSTCreates a client in a workspace. Requires name.
- List projectsGETLists the projects of a workspace, archived or not, 50 per page. A page with fewer than 50 projects is the last one.
- Create projectPOSTCreates a project in a workspace, optionally for a client. Requires name.
- List tasksGETLists the tasks of a project, 50 per page. A page with fewer than 50 tasks is the last one.
- List time entriesGETLists the time entries of a user in a workspace, 50 per page. A page with fewer than 50 entries is the last one. With hydrated true, each entry brings its project, task and tags instead of only their ids.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
