Documentation Index
Fetch the complete documentation index at: https://support.configview.com/llms.txt
Use this file to discover all available pages before exploring further.
ConfigView pulls ClickUp data through one Personal API Token. The token has access to every workspace your ClickUp user is a member of — so the inventory follows your user’s membership, not a per-workspace install.
You will end up with 1 secret in ConfigView (CLICKUP_TOKEN) when setup is complete.
⚠️ Required: token must be generated by a Workspace Admin or Owner
ClickUp’s Personal API Token inherits the generating user’s permissions. ConfigView requires the token to come from a Workspace Admin or Owner — not a regular member, not a guest.
If you use a member-level token:
- Private spaces the member cannot see will be missing from the inventory entirely
Webhooks returns emptyWorkspace Seats returns null seat countsCustom Roles admin-only fields are blank- Other admin-gated data is silently dropped without an error
If the customer doesn’t have an Admin available, ask them to either (a) elevate an existing user temporarily, or (b) create a dedicated service user, promote it to Admin, then generate the token from that account. Don’t proceed with a member-tier token — the data gaps will look like bugs later.
Step 1: Generate the Personal API Token
- Sign in to ClickUp as a Workspace Admin or Owner (see the requirement callout above — this is not optional)
- Verify your role: click your profile avatar (bottom-left) → Settings → My Settings → People (or look at the workspace member list). Your role next to your name must read Admin or Owner. If it reads Member or Guest, stop and follow the workaround in the callout above.
- From Settings, in the left sidebar under My Settings, click Apps
- Under API Token, click Generate (or Regenerate if one already exists)
- Copy the token (starts with
pk_). You can re-view it any time from this page, but treat it like a password.
OAuth alternative. ClickUp also supports OAuth for multi-tenant apps. ConfigView is single-tenant per satellite, so the Personal API Token is the right choice — simpler and works on every plan tier.
Step 2: Add the secret to ConfigView
- Go to your ConfigView dashboard:
https://{companyname}.configview.com/admin/secret/
- Click Add Secret
- Secret name:
CLICKUP_TOKEN
- Secret value: Paste the
pk_... token from Step 1
- Click Save
Step 3: Enable the ClickUp scripts
- Go to:
https://{companyname}.configview.com/admin/cron/
- You should see clickup in the list of available apps
- Select scripts to enable. Parents must be enabled before children — ConfigView wires the dependencies automatically, but the load order matters for first-run timing:
Identity & governance
| Script | Notes |
|---|
| Workspaces | All workspaces your user belongs to. Most other scripts depend on this list. |
| Workspace Plan | Current plan (Free Forever / Unlimited / Business / Business Plus / Enterprise) per workspace. Depends on Workspaces. |
| Workspace Seats | Used vs. total member + guest seats. Useful for billing reconciliation. Depends on Workspaces. |
| Groups (User Groups) | Workspace-defined user groups (e.g. “Engineering”, “Design”). Depends on Workspaces. |
| Custom Roles | Custom role definitions + how many members hold each. Depends on Workspaces. Enterprise-only feature. |
| Webhooks | Active webhooks at the workspace level with their health status (active / failing). Admin-only. Depends on Workspaces. |
| Workspace Custom Fields | Custom field definitions reusable across the workspace. Depends on Workspaces. |
| Custom Task Types | User-defined task types beyond the built-in “Task” (e.g. “Bug”, “Story”). Depends on Workspaces. Business+ feature. |
Hierarchy (Space → Folder → List)
| Script | Notes |
|---|
| Spaces | All spaces in each workspace, both active and archived. Depends on Workspaces. |
| Space Tags | Tag definitions per space. Depends on Spaces. |
| Folders | All folders in each active space, both active and archived. Depends on Spaces. |
| Lists (in Folders) | All lists nested under each folder. Depends on Folders. |
| Folderless Lists | Lists that sit directly under a Space (no folder). Depends on Spaces. |
| List Members | Who has access to each list. Depends on Lists + Folderless Lists. Combines both list sources. |
Tasks & activity
| Script | Notes |
|---|
| Tasks | Every task across every active list, paginated. Depends on Lists + Folderless Lists. Includes subtasks and closed tasks. Largest table — can be hundreds of thousands of rows for active workspaces. |
| Time Entries (Last 30 Days) | Time tracked across the workspace in the last 30 days. Depends on Workspaces. Cumulative history accumulates from successive runs. |
| Goals | Goals + their key results. Depends on Workspaces. Includes completed goals. |
- Click Save
Scoping tip. If you’re rolling out ClickUp ingestion to a workspace with tens of thousands of tasks, enable the Identity and Hierarchy tiers first, verify the row counts look right, then turn on Tasks. The Tasks endpoint paginates 100 rows per request, so a 50k-task workspace is ~500 API calls — well within ClickUp’s per-token rate limit (100 req/min) but takes ~5 minutes per full sync.
Step 4: Verify
- Go to:
https://{companyname}.configview.com/admin/status/
- Run the ClickUp health check
- At minimum Workspaces should return a non-zero row count matching the workspaces your user is in
If a check fails:
401 Token invalid — Token was regenerated or revoked. Re-generate from Step 1 and update CLICKUP_TOKEN.Workspace Seats returns null or zero values — Token’s user is not a Workspace Admin. This is the canary symptom of a member-tier token; re-generate from an Admin/Owner account per Step 1. Do not “accept” this and move on — other endpoints are silently dropping admin-gated data too.Webhooks returns zero rows — Same root cause as the Seats issue. Member-tier tokens see no webhooks. Re-generate from Admin.- Private spaces missing from
Spaces — Same root cause. Member-tier tokens are blind to spaces they’re not invited to. Re-generate from Admin.
Tasks running slowly — Expected for big workspaces. ClickUp’s rate limit is 100 req/min per token; the script paces itself but a 100k-task workspace takes 15-20 minutes. Schedule it daily (or less frequent) rather than hourly.Custom Roles or Custom Task Types returns empty — Feature requires Business+ / Enterprise plan respectively. Empty is the correct answer if you’re on a lower tier.
Data Tables
All tables include a run_at column for historical tracking. Selected highlights below.
| Table | Source | Key Columns |
|---|
clickup_workspaces | GET /team | workspace_id, name, color, members_count |
clickup_workspace_plan | GET /team/{id}/plan | workspace_id, plan_name, plan_id |
clickup_workspace_seats | GET /team/{id}/seats | workspace_id, filled_member_seats, total_member_seats, filled_guest_seats |
clickup_groups | GET /team/{id}/group | group_id, name, handle, member_count, members_json |
clickup_custom_roles | GET /team/{id}/customroles | role_id, name, inherited_role, members_count |
clickup_webhooks | GET /team/{id}/webhook | webhook_id, endpoint, events_json, health_status, health_fail_count |
clickup_spaces | GET /team/{id}/space | space_id, name, private, archived, features_json |
clickup_folders | GET /space/{id}/folder | folder_id, space_id, name, task_count, archived, lists_json |
clickup_lists | GET /folder/{id}/list | list_id, folder_id, name, task_count, due_date, archived |
clickup_folderless_lists | GET /space/{id}/list | list_id, space_id, name, task_count, due_date, archived |
clickup_list_members | GET /list/{id}/member | list_id, user_id, username, email, role, custom_role_id |
clickup_tasks | GET /list/{id}/task (paginated) | task_id, list_id, name, status, assignees_json, priority, due_date, time_estimate, time_spent, custom_fields_json |
clickup_time_entries | GET /team/{id}/time_entries | time_entry_id, task_id, user_id, billable, start_time, duration_ms |
clickup_goals | GET /team/{id}/goal | goal_id, name, percent_completed, owners_json, key_results_json |
What you can’t ingest with this setup
- Task Comments. Comments are fetched per-task (
GET /task/{id}/comment), which means one API call per task. For workspaces of any meaningful size this exceeds the 100 req/min rate limit on a useful cadence. Open a feature request if you need it — we’d ship it as a separate opt-in script with a “last edited” cap.
- Attachments. Same per-task fan-out problem. Out of scope.
- Chat messages / view comments. Out of scope; covered by Slack/Teams ingestion if that’s where the conversation actually happens.
- Views (Kanban / Gantt / Calendar configurations). Not in this version. Easy to add if it matters — request the Views endpoint family.
- Documents (ClickUp Docs). Separate API surface that’s still in beta; not in this version.
