> ## Documentation Index
> Fetch the complete documentation index at: https://nango-wari-migrated-bigcommerce-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickUp

> Integrate your application with the ClickUp API

## 🚀 Quickstart

Connect to ClickUp with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *ClickUp*. Nango doesn't provide a test OAuth app for ClickUp yet. You'll need to set up your own by following these [instructions](#📚-clickup-integration-guides). After that, make sure to add the OAuth client ID and secret in the integration settings in Nango.
  </Step>

  <Step title="Authorize ClickUp">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to ClickUp. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the ClickUp API">
    Let's make your first request to the ClickUp API (fetch the profile of the currently signed-in user). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/api/v2/user" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/api/v2/user',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(JSON.stringify(res.data, null, 2));
        ```
      </Tab>
    </Tabs>

    Or fetch credentials dynamically via the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 ClickUp Integration Guides

Nango maintained guides for common use cases.

* [How to register your own ClickUp OAuth app](/api-integrations/clickup/how-to-register-your-own-clickup-api-oauth-app)\
  Register an OAuth app with ClickUp and obtain credentials to connect it to Nango

Official docs: [ClickUp API docs](https://developer.clickup.com/docs)

## 🧩 Pre-built syncs & actions for ClickUp

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| Function name       | Description                                                                                          | Type                                           | Source code                                                                                                               |
| ------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `create-comment`    | Create a comment in ClickUp on a task or list                                                        | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-comment.ts)    |
| `create-folder`     | Create a folder in ClickUp.                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-folder.ts)     |
| `create-goal`       | Create a goal in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-goal.ts)       |
| `create-list`       | Create a list in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-list.ts)       |
| `create-space`      | Create a space in ClickUp.                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-space.ts)      |
| `create-task`       | Create a task in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-task.ts)       |
| `create-time-entry` | Create a time entry in ClickUp                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/create-time-entry.ts) |
| `delete-comment`    | Delete a comment in ClickUp                                                                          | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-comment.ts)    |
| `delete-folder`     | Delete a folder in ClickUp                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-folder.ts)     |
| `delete-goal`       | Delete a goal in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-goal.ts)       |
| `delete-list`       | Delete a list in ClickUp. This is a permanent delete and all tasks inside the list are also deleted. | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-list.ts)       |
| `delete-space`      | Delete a space in ClickUp                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-space.ts)      |
| `delete-task`       | Delete a task in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-task.ts)       |
| `delete-time-entry` | Delete a time entry in ClickUp                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/delete-time-entry.ts) |
| `get-folder`        | Retrieve a single folder from ClickUp.                                                               | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-folder.ts)        |
| `get-goal`          | Retrieve a single goal from ClickUp                                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-goal.ts)          |
| `get-list`          | Retrieve a single list from ClickUp.                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-list.ts)          |
| `get-space`         | Retrieve a single space from ClickUp                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-space.ts)         |
| `get-task`          | Retrieve a single task from ClickUp.                                                                 | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-task.ts)          |
| `get-time-entry`    | Retrieve a single time entry from ClickUp                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-time-entry.ts)    |
| `get-user`          | Retrieve a single workspace member from ClickUp.                                                     | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/get-user.ts)          |
| `list-comments`     | List comments from ClickUp                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-comments.ts)     |
| `list-folders`      | List folders from a ClickUp space                                                                    | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-folders.ts)      |
| `list-goals`        | List goals from ClickUp                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-goals.ts)        |
| `list-lists`        | List lists from ClickUp                                                                              | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-lists.ts)        |
| `list-spaces`       | List spaces from ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-spaces.ts)       |
| `list-tasks`        | List tasks from a ClickUp list with optional filtering and pagination                                | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-tasks.ts)        |
| `list-time-entries` | List time entries from ClickUp                                                                       | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-time-entries.ts) |
| `list-users`        | List workspace members from ClickUp                                                                  | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/list-users.ts)        |
| `update-comment`    | Update a comment in ClickUp.                                                                         | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-comment.ts)    |
| `update-folder`     | Update a folder in ClickUp                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-folder.ts)     |
| `update-goal`       | Update a goal in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-goal.ts)       |
| `update-list`       | Update a list in ClickUp.                                                                            | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-list.ts)       |
| `update-space`      | Update a space in ClickUp.                                                                           | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-space.ts)      |
| `update-task`       | Update a task in ClickUp                                                                             | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-task.ts)       |
| `update-time-entry` | Update a time entry in ClickUp.                                                                      | [Action](/guides/functions/action-functions)   | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/actions/update-time-entry.ts) |
| `comments`          | Sync comments from ClickUp                                                                           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/comments.ts)            |
| `folders`           | Sync folders from ClickUp.                                                                           | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/folders.ts)             |
| `goals`             | Sync goals from ClickUp                                                                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/goals.ts)               |
| `lists`             | Sync lists from ClickUp                                                                              | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/lists.ts)               |
| `spaces`            | Sync spaces from ClickUp.                                                                            | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/spaces.ts)              |
| `tasks`             | Sync tasks from ClickUp.                                                                             | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/tasks.ts)               |
| `time-entries`      | Sync time entries from ClickUp                                                                       | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/time-entries.ts)        |
| `users`             | Sync workspace members from ClickUp                                                                  | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/clickup/syncs/users.ts)               |

***
