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

# Nooks setup

Configview reads your Nooks workspace through the Nooks partner API (`https://partner-api.nooks.in/v1`), using a **workspace API key** that someone with access creates in Nooks. Configview sends only `GET` requests. It never creates, changes or deletes anything in Nooks.

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

> **Scope of this integration today.** Configview reads who holds a Nooks seat, the company sender mailboxes connected to Nooks and which user owns each, and sequence metadata (name, owner, timing type, enabled, who may see or edit it, and how many steps it has). It never reads prospects, accounts, calls, recordings, transcripts, call dispositions, emails, text messages, tasks, notes, email templates, sequence step content or any enrichment data, and it never calls those endpoints.

***

## Read this first: Nooks API keys cannot be read-only

Nooks API keys have **full read and write access to the workspace**. There is no read-only key and no scopes on a key. Anyone who gets hold of the key could, in principle, create or change sequences, tasks and notes, even though Configview itself only ever reads.

What you can do about it:

* Create the key from a **dedicated user** (for example `configview@yourcompany.com`) that holds a seat, so it does not stop working when a person leaves. The key belongs to the user who generates it.
* Store the key only in Configview and rotate it if the user is removed or the key is ever exposed.

## What the Nooks API does not tell Configview

The API has **no roles, admin flags, last-active dates, 2FA or SSO status, pending invites, teams, phone number or line inventory, integrations list, API key or webhook list, audit log, or credit and usage numbers**. Configview cannot answer who is an admin, who has gone quiet, or what people did in Nooks. Only users with an active seat are returned, so a person who lost their seat simply disappears from the roster.

***

## What you need

* A Nooks workspace with API access to Developer Settings
* Someone who can create an API key

***

## Step 1: Open the Nooks page in Configview

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

## Step 2: Create the key

1. Signed in to Nooks as the dedicated user, open **Developer Settings**, then **API Keys**
2. Create a key and copy it now (it starts with `nooks-api-`)
3. In Configview paste it into `NOOKS_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 |
| - | - |
| **Users** | Seat holders with email, name and CRM user id. |
| **Mailboxes** | Company sender mailboxes with owner and default flag. |
| **Sequences** | Sequence metadata and step count. Content is never read. |

2. Click **Verify now**. The health check reads the secret, calls `GET /me`, then reads one user.

If a check fails: **401** means the key was revoked or mistyped (create a new one). **429** means the per-minute 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 |
| - | - | - |
| `nooks_users` | `GET /users` | user\_id, name, email, crm\_id, has\_crm\_mapping, created\_at, updated\_at |
| `nooks_mailboxes` | `GET /mailboxes` | mailbox\_id, email, is\_default, user\_id, created\_at, updated\_at |
| `nooks_sequences` | `GET /sequences` | sequence\_id, name, sequence\_type, enabled, privacy, owner\_id, step\_count, is\_followup |

***

## Rate limits

Nooks allows 300 requests per minute per list endpoint per workspace (fixed one-minute window). Configview paces at 120 per minute, reads 100 rows per page, and retries a 429 after the `Retry-After` header.

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

These come from the published API description; no live tenant has been tested yet.

* **Pagination.** Configview follows `links.next` (a relative path) with `page[size]=100`. If a list stops early, check that field.
* **Owner ids.** Mailbox and sequence owners arrive as `{id, _href}` references and are assumed to carry the same id as `/users`. If the `owner_id` columns never match `user_id`, the "without a seat" questions will over-report.
* **Step count.** `step_count` is the length of the sequence's step reference list; it is empty if Nooks omits that list without `include=`.
* **Roster size.** `/users` returns only seat holders; a user with a mailbox or sequence but no seat is reported as having no seat.

## Things worth knowing

**Leavers.** A mailbox or sequence whose owner is no longer in the roster usually means the person lost their seat. Check that the mailbox stops sending under their address.

**Team editable sequences.** Sequences with team-editable privacy can be changed by any seat holder, including the outreach that goes to prospects.


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