Clickup Search icon

Clickup Search

Consume Clickup API to get search tasks
Join our community

Overview

This node allows you to search for tasks within a specified team in ClickUp using various filters. It is useful when you want to retrieve tasks based on criteria such as spaces, statuses, due dates, completion dates, update dates, creation dates, and assignees. For example, you can use it to find all open tasks assigned to specific users that are due within a certain date range or to get recently updated tasks in particular spaces.

Properties

Name Meaning
Authentication Choose the authentication method: either an Access Token or OAuth2.
Team Name or ID Select the team from which to fetch tasks. You can choose from a list of teams or specify a team ID via expression.
Space Names or IDs Filter tasks by one or more spaces within the selected team. You can select from a list or specify space IDs via expression.
Status Names or IDs Filter tasks by their status names or IDs within the selected spaces. You can select multiple statuses or specify them via expression.
Include Closed Boolean flag to include closed (completed) tasks in the results. Defaults to false (exclude closed tasks).
Due Date Greater Than Filter tasks with a due date after this date/time.
Due Date Less Than Filter tasks with a due date before this date/time.
Date Done Greater Than Filter tasks completed after this date/time.
Date Done Less Than Filter tasks completed before this date/time.
Date Updated Greater Than Filter tasks updated after this date/time.
Date Updated Less Than Filter tasks updated before this date/time.
Date Created Greater Than Filter tasks created after this date/time.
Date Created Less Than Filter tasks created before this date/time.
Assignees Comma-separated list of user IDs to filter tasks assigned to these users.

Output

The node outputs an array of task objects under the json field. Each object represents a task matching the specified filters and contains detailed information about the task as returned by the ClickUp API. This includes properties like task ID, name, status, due date, assignees, and other metadata.

The node does not output binary data.

Dependencies

  • Requires a valid ClickUp API credential, either an access token or OAuth2 authentication.
  • The node uses internal helper functions to make authenticated requests to the ClickUp API endpoints:
    • /team to load available teams.
    • /team/{team_id}/space to load spaces within a team.
    • /space/{space_id} to load statuses within a space.
    • /team/{team_id}/task to search for tasks with applied filters.
  • No additional external dependencies beyond the ClickUp API and n8n's credential system.

Troubleshooting

  • Common issues:

    • Invalid or expired API credentials will cause authentication errors. Ensure your API key or OAuth2 token is valid.
    • Specifying invalid team, space, or status IDs may result in empty results or API errors.
    • Date filters must be valid ISO date-time strings; otherwise, the API may reject the request.
    • Large result sets might lead to timeouts or rate limiting by the ClickUp API.

  • Error messages:

    • Authentication failures typically indicate incorrect or missing credentials.
    • "Not Found" errors may occur if the team, space, or status IDs do not exist or are inaccessible.
    • Rate limit errors require waiting before retrying or reducing request frequency.

To resolve errors, verify credentials, check that IDs correspond to existing resources, and ensure date formats are correct.

Links and References

Discussion