Skip to main content

ClickUp Data Source

The ClickUp connector enables you to ingest tasks, lists, folders, spaces, time-tracking entries, custom fields, comments, goals, and team data from your ClickUp Workspace. Follow the instructions below to create a new data flow that ingests data from a ClickUp source in Nexla.
click_up_api.png

ClickUp

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the ClickUp connector tile from the list of available connectors. Then, select the credential that will be used to connect to the ClickUp instance, and click Next; or, create a new ClickUp credential for use in this flow.

  3. In Nexla, ClickUp data sources can be created using pre-built endpoint templates, which expedite source setup for common ClickUp endpoints. Each template is designed specifically for the corresponding ClickUp endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    ClickUp sources can also be configured manually, allowing you to ingest data from ClickUp endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common ClickUp endpoints. Each template is designed specifically for the corresponding ClickUp endpoint, making data source setup easy and efficient.

ClickUp organizes data in a hierarchy: a Workspace (referred to as a Team in the API v2) contains Spaces, which contain Folders, which contain Lists, which contain Tasks. Many endpoints require an ID from a higher level in this hierarchy. You can obtain these IDs by first running the corresponding listing endpoint (for example, run Get Spaces to find a Space ID, then Get Folders to find a Folder ID).

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Current User

    This endpoint retrieves the profile information of the user that owns the authenticating personal API token. Use it to confirm connectivity or to capture the acting user's identity, username, and email.

    • This endpoint requires no additional configuration. Select it and proceed to testing.

    This endpoint calls GET /api/v2/user and returns a single user record. It is a quick way to verify that your credential is valid before configuring more complex sources.

    Get Team

    This endpoint retrieves the Workspaces (called Teams in the API v2) that the authenticating user belongs to. Use it to discover the Team IDs needed to configure most other ClickUp endpoints.

    • This endpoint requires no additional configuration. Select it and proceed to testing.

    This endpoint calls GET /api/v2/team and returns one record per Workspace, including each Workspace's ID, name, color, and members. Note the Team ID from the response, as it is required by many of the other endpoints below.

    Get Spaces

    This endpoint retrieves all Spaces within a Workspace. Spaces are the top-level organizational containers in ClickUp and hold Folders and Lists.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/space and returns one record per Space, including each Space's ID and name. Use these Space IDs to configure the Get Folders and List Space Tags endpoints.

    Get Folders

    This endpoint retrieves all Folders within a Space. Folders group related Lists together inside a Space.

    • Enter the identifier of the Space whose Folders you want to retrieve in the Space ID field. You can obtain Space IDs by first running the Get Spaces endpoint.

    This endpoint calls GET /api/v2/space/{space_id}/folder and returns one record per Folder. Use the returned Folder IDs to configure the Get Lists endpoint.

    Get Lists

    This endpoint retrieves all Lists within a Folder. Lists are the containers that hold individual Tasks in ClickUp.

    • Enter the identifier of the Folder whose Lists you want to retrieve in the Folder ID field. You can obtain Folder IDs by first running the Get Folders endpoint.

    This endpoint calls GET /api/v2/folder/{folder_id}/list and returns one record per List. Use the returned List IDs to configure task-related endpoints such as Get Tasks.

    Get Tasks

    This endpoint retrieves all Tasks within a single List. Use it to ingest task data—including names, statuses, assignees, priorities, and due dates—for reporting or synchronization.

    • Enter the identifier of the List whose Tasks you want to retrieve in the List ID field. You can obtain List IDs by first running the Get Lists endpoint.

    This endpoint calls GET /api/v2/list/{list_id}/task. Responses are limited to 100 tasks per page; Nexla handles pagination automatically, advancing the page parameter to fetch all available tasks.

    Get Task

    This endpoint retrieves the full details of a single Task by its ID. Use it when you need detailed information about one specific task rather than a list of tasks.

    • Enter the identifier of the Task to retrieve in the Task ID field. Task IDs are returned by the Get Tasks and Get Filtered Team Tasks endpoints.

    This endpoint calls GET /api/v2/task/{task_id} and returns a single task record with its complete field set, including custom fields, assignees, and status.

    Get Filtered Team Tasks

    This endpoint retrieves tasks across the entire Workspace, supporting filters by assignee, status, tag, due date, and other criteria. Use it when you need a workspace-wide view of tasks rather than tasks from a single List.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/task and is paginated at 100 tasks per page; Nexla advances the page parameter automatically. To apply additional filters such as status or assignee, configure the source manually and add the corresponding query parameters to the API URL.

    Get Time Tracking Entries

    This endpoint retrieves time-tracking entries recorded within a Workspace. Use it to analyze how time is being logged against tasks for billing, capacity, or productivity reporting.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/time_entries and returns one record per time entry, including duration, start time, and the associated task and user.

    Get Time Tracking Tags

    This endpoint retrieves all tags configured for time tracking within a Workspace. Time-tracking tags are used to categorize and label time entries.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/time_entries/tags and returns one record per time-tracking tag.

    Get List Custom Fields

    This endpoint retrieves the custom fields configured for a specific List. Use it to understand the structure of custom data captured on tasks within that List.

    • Enter the identifier of the List whose custom fields you want to retrieve in the List ID field. You can obtain List IDs by first running the Get Lists endpoint.

    This endpoint calls GET /api/v2/list/{list_id}/field and returns one record per custom field, including each field's ID, name, and type. These Field IDs are needed to set custom field values from the destination side.

    Get Team Custom Fields

    This endpoint retrieves the custom fields available across an entire Workspace. Use it to inventory all Workspace-level custom fields in a single call.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/field and returns one record per custom field defined at the Workspace level.

    List Space Tags

    This endpoint retrieves all tags defined within a specific Space. Tags are used to label and categorize tasks across a Space.

    • Enter the identifier of the Space whose tags you want to retrieve in the Space ID field. You can obtain Space IDs by first running the Get Spaces endpoint.

    This endpoint calls GET /api/v2/space/{space_id}/tag and returns one record per tag, including each tag's name and colors.

    List Team Goals

    This endpoint retrieves all Goals defined for a Workspace. Goals track measurable targets composed of one or more Targets (key results) in ClickUp.

    • Enter the Workspace identifier in the Team ID field. You can obtain this value by first running the Get Team endpoint.

    This endpoint calls GET /api/v2/team/{team_id}/goal and returns one record per Goal, including progress and owner information.

    List Comments

    This endpoint retrieves all comments posted on a specific List. Use it to ingest List-level discussion and collaboration data.

    • Enter the identifier of the List whose comments you want to retrieve in the List ID field. You can obtain List IDs by first running the Get Lists endpoint.

    This endpoint calls GET /api/v2/list/{list_id}/comment and returns one record per comment, including the comment text, author, and timestamp.

    Get Task Comments

    This endpoint retrieves all comments posted on a specific Task. Use it to ingest task-level discussion threads.

    • Enter the identifier of the Task whose comments you want to retrieve in the Task ID field. Task IDs are returned by the Get Tasks and Get Filtered Team Tasks endpoints.

    This endpoint calls GET /api/v2/task/{task_id}/comment and returns one record per comment.

    Get List Members

    This endpoint retrieves all members who have access to a specific List. Use it to audit access or to map task assignees to users.

    • Enter the identifier of the List whose members you want to retrieve in the List ID field. You can obtain List IDs by first running the Get Lists endpoint.

    This endpoint calls GET /api/v2/list/{list_id}/member and returns one record per member, including each member's ID, username, and email.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

ClickUp data sources can be manually configured to ingest data from any valid ClickUp API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need to apply query-parameter filters such as status, assignee, due-date ranges, or subtasks.

With manual configuration, you can also create more complex ClickUp sources, such as sources that apply the workspace-wide task filters supported by the Get Filtered Team Tasks endpoint or sources that include custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the ClickUp API from the Method pulldown menu. ClickUp read endpoints use the GET method.

API Endpoint URL​

  1. Enter the URL of the ClickUp API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters—for example, https://api.clickup.com/api/v2/list/{list_id}/task to retrieve tasks from a specific List.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. ClickUp filters such as ?statuses[]=open or ?include_closed=true can be appended to the URL as query parameters.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is useful with ClickUp endpoints that accept date filters such as due_date_gt or date_updated_gt.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For example, you can use a lookup of List IDs gathered from the Get Lists endpoint to iterate task retrieval across multiple Lists.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. ClickUp responses typically wrap records in a named array (for example, tasks are returned under a tasks array and Lists under a lists array).

For example, when fetching tasks from a List, the API returns an array of records under the tasks key. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.tasks[*] to access the array of tasks in a ClickUp response).
    Path to Data Example:

    For the ClickUp Get Tasks endpoint, which returns a top-level array named tasks, the path to the response would be entered as $.tasks[*]. For Get Lists, use $.lists[*], and for Get Spaces, use $.spaces[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, ClickUp's task responses include the tasks array along with fields such as last_page. If you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom requirements.

    You do not need to include any headers already present in the credentials. The Authorization header containing your ClickUp personal API token is applied automatically by Nexla based on your credential configuration.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new ClickUp data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.