> ## 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.

# Excalidraw+ setup

Configview reads your Excalidraw+ workspace through the Excalidraw+ API (`https://api.excalidraw.com/api/v1`), using a **workspace API key with Read only access** that a workspace owner or admin creates. Configview only sends `GET` requests. It never creates, changes or deletes anything in Excalidraw+, and it never calls the scene content endpoints.

You will end up with **1 required secret** (`EXCALIDRAW_API_KEY`) in Configview when setup is complete.

> **Scope of this integration today.** Configview reads who is in the workspace and with what role, invites and invite links, the shared collections, a sharing inventory of scenes (whether a public link or shared slides link exists, its access, owner, dates), and the workspace audit log for the last 90 days (link sharing, role changes, invites, sign-ups, AI use). It never reads or stores drawing content, files, comments, link URLs (they carry the scene key) or private collections. A scene name is stored only for scenes that have a public link, so a risky link can be found.

***

## What you need

* An Excalidraw+ workspace and an owner or admin to create the key
* A **workspace** key. A personal key sees one member's scenes only, and a collection key gets `403` on members, invites and logs

***

## Step 1: Open the Excalidraw+ page in Configview

`https://{companyname}.configview.com/admin/integrations/excalidraw`

## Step 2: Create the key

1. In Excalidraw+ open **Workspace settings**, then **MCP/API Keys**
2. Create a **workspace key**, choose access **Read only**, and set the expiry you want
3. Copy the key now: it is shown only once
4. In Configview paste it into `EXCALIDRAW_API_KEY` under **Credentials** and click the save icon

**Keys expire.** Excalidraw+ keys carry the expiry you pick at creation, after which every call returns `401`. Write the date down, create a replacement key before then and update the secret. The health check reports `401` when this happens.

## Step 3: Connect and verify

1. Click **Connect**. Configview creates its tables and schedules every collector at your default run time:

| Script | Notes |
| - | - |
| **Workspace** | Workspace id and name with counts of members, admins, invites and collections. |
| **Users** | Members with email, name, role and status. |
| **Invites** | Email invites and invite links with role, uses, domain restriction and age. |
| **Collections** | Shared collection names and dates. |
| **Scenes** | Sharing inventory, metadata only. |
| **Audit Logs** | Last 90 days of the audit log: actor, action, target id and time. |

2. Click **Verify now**. The health check reads the secret, calls `GET /workspaces`, then reads one page of members.

If a check fails: **401** means the key is wrong, revoked or expired. **403** means it is not a workspace key with access to workspace routes (a collection key or a personal key). **429** means the rate limit was hit; retry in a minute.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run.

| Table | Source | Key Columns |
| - | - | - |
| `excalidraw_workspace` | `GET /workspaces`, members, invites and collections | workspace\_id, name, user\_count, admin\_count, invite\_count, collection\_count |
| `excalidraw_users` | `GET /workspaces/users` | user\_id, email, name, member\_role, status, created\_at, last\_active\_at |
| `excalidraw_invites` | `GET /workspaces/invites` | invite\_id, kind, email, invite\_role, status, use\_count, max\_uses, restricted\_domains, created\_at, expires\_at |
| `excalidraw_collections` | `GET /collections` | collection\_id, name, created\_by, created\_at |
| `excalidraw_scenes` | `GET /scenes` | scene\_id, collection\_id, owner\_id, has\_public\_link, public\_link\_access, has\_slides\_link, public\_scene\_name (public-link scenes only), updated\_at |
| `excalidraw_audit_logs` | `GET /logs` (last 90 days) | log\_id, actor\_id, action, operation, target\_type, target\_id, created\_at |

***

## Rate limits

Excalidraw+ allows **600 requests per minute per API key**, shared with the MCP endpoint. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`; a `429` carries `Retry-After`. Configview paces at 300 requests per minute, reads 100 items per request (the maximum) and waits out a `429`. Requests with a bad or expired key count against a much lower per-IP limit, so fix the key rather than retrying.

## Known gaps and things to check on the first run

These come from the public API reference ([https://plus.excalidraw.com/docs/api](https://plus.excalidraw.com/docs/api)); it has no example payloads and no live tenant has been tested yet.

* **Field names are inferred.** The reference does not show response bodies, so Configview reads several likely names for each field (for example `createdAt`, `joinedAt`). After the first run check the tables for empty columns (`role`, `status`, `last_active_at`, invite fields, scene link fields).
* **Last active.** The member list may not carry a last-active time. If `last_active_at` stays empty, the "inactive members" question relies on audit log entries only, so reading without editing does not count.
* **Link fields on scenes.** The scene list returns read-only and shared slides links. Configview records only whether they exist, their access (assumed `view` when the object does not say) and the link host, never the URL. If the field names differ, `has_public_link` shows 0 for every scene: check this first.
* **Audit log filters.** The log is cursor paged and filterable by date, but the exact query parameter names are not in the REST reference (the CLI uses date-from and date-to). Configview sends `dateFrom`, also filters on its own side, and stops after 300 pages (30,000 entries). If the date filter is ignored and the log is oldest first, the newest entries may be missed.
* **Audit log actors.** Entries are expected to name the actor by user id only, which Configview joins to the member list.
* **Workspace settings.** The workspace object has settings (for example whether scene sharing is disabled) but their names are not documented, so they are not stored.
* **Key expiry** is not exposed by the API, so Configview cannot show it: track the date yourself.
* **Private collections** are never visible to a workspace key.

## Things worth knowing

**Public links.** Anyone with a scene's public link can open it without signing in, and with an edit link can change it. Review those scenes first.

**Invite links.** An invite link without an email domain restriction can be redeemed by anyone who gets the link.

**Leavers.** Scenes owned by someone no longer in the member list keep their sharing settings.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.