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

# Lumin PDF setup

Configview reads your Lumin PDF workspace through the Lumin public API (`https://api.luminpdf.com/v1`), using a **workspace API key** that the Workspace Owner creates in Lumin. Configview sends only `GET` requests. It never creates, changes or deletes anything in Lumin.

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

> **Scope of this integration today.** Configview reads who is a member of your Lumin workspace (work email, name, role, joined date, last active time), the Spaces (name, member count, created date), the workspace totals, and the user the API key acts as. It never calls the document, signature request, template or agreement endpoints, so no document, PDF, signer or template content is read.

***

## Read this first: the key acts as its creator

* Lumin API keys have **no scopes**. A key acts as the user who created it, so create it as the **Workspace Owner** (or a dedicated owner account) to get a complete member list.
* Keys are long-lived: they work until someone deletes them. A workspace can hold at most 4 keys. Rotate by creating a new key, pasting it into `LUMIN_API_KEY` and deleting the old one.

## What the Lumin API does not tell Configview

The API has **no audit log, webhook list, API key list, 2FA or SSO status, pending invites or Space member lists**. Configview cannot answer who did what, which keys exist besides its own, or who sits in each Space. Only member counts per Space are known.

***

## What you need

* A Lumin workspace and the Workspace Owner to create the key
* Developer settings access in Lumin (API keys can be created from the workspace settings)

***

## Step 1: Open the Lumin page in Configview

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

## Step 2: Create the API key

1. Signed in to Lumin as the Workspace Owner, open **Settings > Developer settings > API keys**
2. Create a key named `Configview`
3. Copy the key now
4. In Configview paste it into `LUMIN_API_KEY` under **Credentials** and click the save icon

## Step 3: Connect and verify

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

| Script | Notes |
| - | - |
| **Members** | The roster with role, joined date and last active time. |
| **Spaces** | Space names, member counts and the key owner's role. |
| **Key Owner** | The user the API key acts as. |
| **Workspace** | One row: workspace name, owner, totals and members per role. |

2. Click **Verify now**. The health check reads the secret, calls `GET /v1/user/info`, then `GET /v1/workspaces/info`.

If a check fails: **401** means the key is mistyped or deleted. **403** means the key's owner lacks access to that endpoint. **429** means a rate limit was hit; retry in a minute.

***

## Data Tables

Each table has a `run_at` column and keeps only the newest run. No raw API objects are stored.

| Table | Source | Key Columns |
| - | - | - |
| `lumin_members` | `GET /v1/workspaces/members` | user\_id, email, name, member\_role, joined\_at, last\_active\_at |
| `lumin_spaces` | `GET /v1/workspaces/spaces` | space\_id, name, key\_user\_role, total\_members, created\_at |
| `lumin_key_owner` | `GET /v1/user/info` | user\_id, email, name |
| `lumin_workspace` | `GET /v1/workspaces/info` + members | workspace\_id, name, owner\_email, created\_at, total\_members, total\_spaces, owner\_count, admin\_count, member\_count |

***

## Rate limits

Lumin publishes no rate limit for its API. Configview paces itself at 60 requests per minute, reads 50 rows per page (the maximum) and waits as long as the `Retry-After` header says after a 429. A workspace needs only a handful of requests per run.

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

These come from the published OpenAPI reference; no live tenant has been tested yet.

* **Epoch units.** The reference calls `joined_at` and `last_active_at` unix epochs, but its example shows milliseconds. Configview reads values above 1e11 as milliseconds. If dates look like 1970 or the far future, check this first.
* **total\_count.** It is a string in the members example; Configview parses it either way.
* **WorkspaceInfo fields.** The `owner` field is assumed to be the owner's email, as documented.
* **Last active.** A missing or zero `last_active_at` is stored as empty and shown as "never active".
* **Plan limits.** Spaces are limited to 2 on Free plans. API access on lower plans is not confirmed.
* **Space names** are chosen by users; they are stored as labels only.

## Things worth knowing

**Inactive members.** Members not active for 90 days (or never) may have left the company but still hold access to shared Spaces. Owners and admins who are inactive are flagged separately.

## What isn't collected

* Documents, PDFs, signature requests, signers, templates and agreements
* Space contents and Space member lists
* The API key value and raw API objects


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