Toggl icon

Toggl

Interact with Toggl Track API
Join our community

Actions8

Overview

This node interacts with the Toggl Track API to manage clients within a specified workspace. Specifically, the "List Clients" operation retrieves a list of clients filtered by workspace ID, status, and optionally by client name. This is useful for scenarios where you want to automate reporting, synchronize client data with other systems, or filter clients based on their active or archived status.

Practical examples:

  • Automatically fetching all active clients in a workspace to generate billing reports.
  • Retrieving both active and archived clients to perform data cleanup or migration.
  • Filtering clients by name to find specific client details before creating related projects or time entries.

Properties

Name Meaning
Workspace ID ID of the workspace to list clients from (required).
Status Status of clients to retrieve. Options: Active, Archived, Both.
Client Name Filter Case-insensitive filter to return only clients whose names match this string (optional).

Output

The output is an array of JSON objects, each representing a client retrieved from the Toggl Track API. Each object contains client details such as client ID, name, external reference, notes, and status.

If multiple clients are returned, each client is output as a separate item in the node's output array.

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Toggl Track API.
  • The node uses the Toggl Track API endpoints to fetch client data.
  • Proper workspace access permissions are necessary to retrieve clients.

Troubleshooting

  • Common issues:

    • Invalid or missing workspace ID will result in no clients being returned or an error.
    • Incorrect API credentials or expired tokens will cause authentication errors.
    • Providing invalid values for the status filter may lead to unexpected results or empty lists.

  • Error messages:

    • "Invalid JSON in body parameter" or "Invalid JSON in query parameters" do not apply here since this operation does not use these inputs.
    • Errors related to "No running time entry found" or others are unrelated to this operation.
    • If the API returns an error, ensure the workspace ID exists and the API key has sufficient permissions.

Links and References

Discussion