Try the API in your web browser

You can test the ClickUp API directly in your web browser on any endpoint page in the API Reference using the Try It option.

Use your API Key to access your own ClickUp data, or use the mock server for testing with generic data.

Note

Your ClickUp data and token are not stored when testing the API. The token is only kept for the duration of your session.

Step 1: Enter your API Key

  1. Go to an endpoint page.
  2. Click Try It , in the upper-right corner.
  3. Expand the Security section.
  4. Paste your API key.

Screenshot of the security section of the Try It modal.

Tip

Using the mock server? Any value is accepted as an authorization key.

Step 2: Enter Request Details

  1. In the Body section, add the request details. Screenshot of the body section of the Try It modal.
  2. In the Parameters section, add your request parameters.

Screenshot of the parameters section of the Try It modal.

Tip

In the mock server, any value is accepted for required and optional fields.

Step 3: Select a Target Server

Choose from the following servers:

  1. https://api.clickup.com/v2 - ClickUp API
  2. https://{mock-server-id}.remockly.com - Mock Server

Screenshot of the Try It Modal highlighting the option to select a server