Nooks

Returns a single call by its unique identifier.

getCall

Returns a single call disposition by its unique identifier.

getCallDisposition

Returns the full transcript of a single call as speaker-labeled, timestamped turns, preceded by structured call metadata (rep, contact, duration, disposition, talk ratio). Use `listCalls` to discover call IDs. Only available for calls made by reps with an AI Coaching seat — calls made by unlicensed reps return an access-denied error. Very long transcripts are truncated, with a notice appended when that happens (`truncated: true`). Not every call has a transcript: when the recording was never transcribed, the response is `hasTranscript: false` with `transcript: null` (use `listCalls` with `filter[hasTranscript]=true` to list only calls that have one).

getCallTranscript

Returns a single Nooks Desktop meeting note by its unique identifier. Only resolves notes belonging to the calling rep's own account. Also called "Nooks notes", "desktop notes", or plain "meeting notes" — these all refer to the same Nooks Desktop meeting notes.

getDesktopNote

Get email by ID Returns a single email by its unique identifier. Unlike `GET /v1/emails`, this endpoint also returns unsent drafts and queued sends (e.g. created via `POST /v1/emails`). Those come back with `status: draft` and `type: null` until the email actually sends.

getEmail

Get email template by ID Returns the full content of a single email template by its unique identifier. Template IDs come from `GET /v1/emailTemplates` or the `template` reference on a sequence step (use `GET /v1/sequenceSteps/{id}?include=template` to inline the template DTO directly).

getEmailTemplate

Get mailbox by ID Returns a single mailbox by its unique identifier.

getMailbox

Get the authenticated principal Returns the workspace and user for the current credential. A `200` confirms the credential is valid; `401` means it's expired, revoked, or malformed. - For OAuth callers, `userId` is the end user who authorized the token (JWT `sub`). - For API-key callers, `userId` is the Nooks user who generated the key on the API Keys page in Developer Settings. - `userId` is always populated. `email` and `name` are `null` if that user no longer has a seat in the workspace. - `clientId` and `scopes` are `null` for API-key callers (API keys have full workspace access). Response is intentionally flat as an introspection endpoint and doesn't follow the nested ReferenceObject shape the resource endpoints use. Available to any authenticated caller regardless of granted scopes.

getMe

Returns a single prospect by its unique identifier

getProspect

List Nooks egress IP addresses Returns the public IPv4 addresses Nooks connects from when it calls your systems: webhook deliveries, CRM syncs, and other outbound integrations. Allowlist these if your firewall or webhook receiver restricts inbound traffic by source IP. No authentication is required. The list is refreshed daily and new addresses may be added over time, so poll this endpoint daily to keep your allowlist current. Responses are cacheable for one hour.

getPublicIpList

Get sequence by ID Returns a single sequence by its unique identifier.

getSequence

Get sequence state by ID Returns a single sequence state by its unique identifier.

getSequenceState

Get sequence step by ID Returns a single sequence step by its unique identifier.

getSequenceStep

Get task by ID Returns a single task by its unique identifier.

getTask

Returns a single Nooks native team with its full member list (userId, name, email per member). Use this to inspect team composition — e.g. which reps roll up into a team — before filtering other tools by team.

getTeam

Get user by ID Returns a single user by their unique identifier. Returns 404 if the user does not exist or does not have a seat assignment in the workspace.

getUser

Returns a paginated list of accounts (companies) in the workspace, across every source platform. Supports filtering by id, exact name (no substring match), exact domain, CRM ID, source platform, and updatedAt range. Account IDs also appear on call records (`filter[account][id]` on listCalls); use getAccount to resolve an account ID to its full record. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listAccounts

Returns a paginated list of call dispositions for the workspace. Supports filtering by id, exact name, and source. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listCallDispositions

Data-export tool: returns a paginated list of every call in the workspace. Supports filtering by id, call time, prospect, account, disposition, owner, team, and transcript availability. This is not the right tool for searching through calls or any coaching/insight related use cases. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listCalls

Returns the calling rep's own Nooks Desktop meeting notes, most recent first. With no filter, returns recent notes across all meetings. Filter by account or prospect to scope to a specific CRM record, and/or by filter[startedAt][gte]/[lte] to scope to a date range. Never returns another rep’s notes. Also called "Nooks notes", "desktop notes", or plain "meeting notes" — these all refer to the same Nooks Desktop meeting notes.

listDesktopNotes

List email templates Returns the templates on the workspace's Templates page, ordered by `id` and paginated with cursors. Each item includes the full subject and body. To fetch a single template, call `GET /v1/emailTemplate/{id}`, which uses the singular `emailTemplate`. By default the list returns only active templates. `filter[archived]=true` returns only archived ones. The list does not include the copies of a template that sequence steps make. To read one of those, call `GET /v1/sequenceSteps/{id}?include=template`. There is no name search. Narrow the list with the owner or `updatedAt` filters, or page through it. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listEmailTemplates

List emails Returns a paginated list of emails. Supports filtering by ID, prospect, task, status, and updatedAt range. Unsent drafts (e.g. created via `POST /v1/emails` with `send: false`) do not appear in this list until they are sent, including when filtering by id (`filter[id]` silently omits draft ids) or by `filter[status]=draft`. Fetch drafts by id via `GET /v1/emails/{id}`. `filter[task][id]` matches the sequence task that triggered the email. `filter[account][id]` joins through the email's prospect. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listEmails

List mailboxes Returns a paginated list of mailboxes (email aliases). Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listMailboxes

Returns a paginated list of prospects. Supports filtering by id, name, title, primary email, CRM ID, source platform (`type`), sequence enrollment, account, and updatedAt range. `crmId` is null for non-CRM prospects. When the same person exists as both a CRM-typed (`salesforce`/`hubspot`) record and an external-sequencing-platform record (outreach/salesloft/gong/apollo/groove), the CRM record is the canonical one — enrolling the other into a Nooks sequence resolves to the CRM record when it exists and is rejected when it does not. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listProspects

List sequence states Returns a paginated list of sequence states (enrollments). Supports filtering by sequence, prospect, account, and state. `filter[account][id]` joins through the prospect. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listSequenceStates

List sequence steps Returns a paginated list of sequence steps. Supports filtering by step IDs or by sequence. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listSequenceSteps

List sequences Returns a paginated list of sequences. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listSequences

List tasks Returns a paginated list of tasks. Tasks represent individual outreach activities (calls, emails, etc.) assigned to users. `filter[account][id]` joins through the task's prospect. The `updatedAt` range is half-open: `gte` is inclusive, `lt` is exclusive. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listTasks

Returns all active Nooks native teams in the workspace with their member counts. Use this to discover valid team IDs and names before filtering other tools by team — e.g. a team ID returned here can be passed to `listCalls` as filter[team][id], or to `searchConversations` as hostTeamIds / participantTeamIds.

listTeams

List users Returns a paginated list of users in the workspace. Only users with active seat assignments are returned. Filter by CRM id. Looks up the Nooks user mapped to the given external id in the connected CRM (e.g. a Salesforce `User.Id` / `OwnerId`). `filter[crmId]` returns an empty list if no Nooks user is mapped to that id. Pagination: start with `page[size]=25`. Only request larger pages if you actually need more — responses above that threshold can be truncated or spilled to an attached file by MCP clients. Use the `links.next` cursor (`page[after]`) to page through results instead of increasing `page[size]`.

listUsers

PREFERRED tool for finding and analyzing calls for coaching, QA, and review. Searches what was actually said: pass `transcriptQuery` to find calls containing a keyword or phrase anywhere in the transcript, and/or `speakerQuery` (optionally scoped to the `rep` or `prospect`) to find a phrase in a single speaking turn. Returns the matching calls (most recent first) with the matching transcript snippets, so you can pull up the right calls to analyze or coach on — e.g. how a rep handled an objection, talked about pricing, or ran discovery. The transcript and speaker keyword search is what sets this apart from `listCalls`, which cannot search transcript text. Transcript/speaker queries are optional, so this also serves as a fast, relevance-ranked call search even when you only filter by time, prospect, account, disposition, outcome, minimum duration, owner, or team. SCOPE: only covers calls placed by reps with an AI Coaching seat — for a complete export of every call in the workspace (including unlicensed reps), use `listCalls` instead. Results are cursor-paginated and capped at 10,000 (`totalCount` is a lower bound, shown as "N+", once that cap is reached).

searchCalls

Fuzzy-searches the calling rep's own Nooks Desktop meeting notes by title and participant/company name (not note bodies, AI summaries, or transcripts). Also returns matching People and Companies derived from the notes' attendees — each carries `noteIds` (their own notes, most recent first) and a `noteCount` total, so fetch those with getDesktopNote rather than searching again, plus a `prospectId`/`accountId` when the attendee resolved to a CRM record (usable as listDesktopNotes filter[prospect][id]/filter[account][id]). Optionally scoped to a filter[startedAt][gte]/[lte] date range — omit `q` to just list notes in that range. Never returns another rep's notes. Also called "Nooks notes", "desktop notes", or plain "meeting notes" — these all refer to the same Nooks Desktop meeting notes.

searchDesktopNotes

Skip a task Skips a task without completing the associated action. For sequence tasks, skipping advances the prospect to the next step in the sequence. The task status will be updated to `skipped`.

skipTask

Sync prospects from CRM Syncs up to 100 CRM records (Salesforce or HubSpot) into Nooks prospects by `externalId`, creating them if they don't already exist. Per-record outcomes are returned in `results` and `errors`.

syncProspects

Update a sequence Updates a sequence's name and/or `enabled` flag. Setting `enabled` to `false` archives the sequence; `true` reactivates it. At least one field must be provided. OAuth callers with the `user` role can only update sequences they own (`403 INSUFFICIENT_PERMISSION` otherwise); `admin` and `manager` roles can update any sequence in the workspace.

updateSequence

Replace an enrollment's email overrides Replaces the per-step email content overrides of a prospect that is already enrolled, using the same `emailOverrides` shape as `POST /sequenceStates`. Use this to refresh personalized content on an in-flight enrollment instead of removing and re-enrolling the prospect. **The request body is the complete set of overrides for the enrollment**, not a merge: - A step in `emailOverrides` that already has an unsent email (the current step, or a step overridden earlier) has its subject and body rewritten in place. A field you omit (`subject` or `body`) reverts to the step's template, not to the previous override; on a step with no template it keeps its current value. - A step in `emailOverrides` with no email yet gets a pending email that is used when the enrollment reaches it. - **An email step you leave out of `emailOverrides` loses any override it had**: a not-yet-reached step goes back to sending the step's template, and the current step's unsent draft is reverted to the template's content. This includes edits a user made to that draft in the Nooks Outbox. Only email steps can be overridden, and only the current step or later ones. Already-sent emails and AI-generated Play emails are never touched. The request is all-or-nothing: if any step is rejected, nothing is changed. Listing the enrollment's tasks (`GET /tasks?filter[prospect][id]=…&filter[sequence][id]=…`) shows which not-yet-reached email steps already have a `pending` task, but not why: a pending task can come from an override or from an AI-generated Play email (which this request never touches), and unsent draft content is not returned by `GET /emails` (see that endpoint). Treat this request as declaring the full desired set of overrides rather than reading the current one back first. Returns 409 if the enrollment is finished, or if the email for a step in `emailOverrides` has already been sent.

updateSequenceState

Update a task Updates one or more fields on an existing task. Only the following fields can be changed: - `dueAt` reschedules the task to a new due date and time - `ownerId` reassigns the task to a different user - `priority` changes the task priority (`low`, `normal`, `high`, `urgent`) - `note` updates the task note (set to `null` to clear) At least one field must be provided. All other task fields (action, prospect, sequence, etc.) are immutable through this endpoint.

updateTask