Skip to main content

​
Overview

The Developer page (admin role only) has three tabs: Keys, API Reference, and MCP. Deep-link to a tab with ?tab=reference or ?tab=mcp; the default is Keys.

​
Keys tab

Manage the API keys used to authenticate REST and MCP requests. See Authentication for how the header works. The table lists each generated key: type (Read & write / Read only / Master), status, a masked value (prefix, dots, last 4 characters), scope (Client or Master), and per-key actions.
  • Generate key opens a dialog to create one of the three key types. A key can only be generated once per type; generating shows the full value one time in a reveal dialog, then it’s masked everywhere after.
  • Regenerate key issues a new secret for that key type immediately; old integrations using the previous value break until updated.
  • Revoke key deletes the key; this cannot be undone and breaks any integration using it.
  • Read & write and Read only keys are scoped to whichever client is currently selected in the dashboard sidebar; a note reminds you to pick a client if none is selected. The Master key is agency-wide and doesn’t need a client selected, but only shows up if your agency permissions include master list access.

​
API Reference tab

An interactive, searchable reference generated from the RevyOps OpenAPI spec. Controls:
  • Client / Master scope toggle (Master only shown if you have master list access): Client scopes results to the single-workspace REST endpoints; Master scopes to the cross-client master list endpoints.
  • v1 / v2 version toggle: v1 is marked deprecated (still works, but v2 adds pagination and a cleaner response structure and is recommended for new integrations).
  • A search box filters endpoints by path, title, or HTTP method.
  • Endpoint groups (Contacts, Companies, Contact/Company custom fields, People, Global Update, etc.) are collapsible; the first group is open by default, and searching expands all matching groups.

​
MCP tab

Walks through connecting a third-party LLM agent (e.g. Claude) to the workspace via the RevyOps MCP server, in three steps: choose an API key (links to the Keys tab), install an agent desktop app, then add the RevyOps MCP server to that app’s config using the X-API-KEY header. Multiple client keys can be comma-separated in the header to give one agent access to several workspaces. The tab also includes collapsible sections for troubleshooting, workspace access and key security notes, query tips, performance/rate-limit figures, and a privacy summary. See MCP Overview and Tools Reference for the full tool catalog.