Skip to main content
API and MCP

API and MCP Settings and Documentation

API and MCP allow you to securely connect other systems and artificial intelligence tools to your Hanna account. This section is intended for administrators and Staff who have been granted API and MCP access.

Last updated 13 days ago

API and MCP allow you to securely connect other systems and artificial intelligence tools to your Hanna account. This section is intended for administrators and users who have been granted API and MCP access.

How to Access API and MCP Settings

  1. Open System Settings.
  2. Select API and MCP from the left-hand menu.
  3. On the page that opens, you will see active keys and connections, their associated users, status, expiration dates, and last usage times.

If you do not see this section, please contact an administrator. They must be granted API and MCP access in their user profile. Access to this section does not alter the user's role or grant additional CRM data access.

Where to Find API Documentation

Click API Documentation at the top of the page. This opens the API v4 documentation tailored to your account. Here you can:

  • select a CRM module;
  • view available operations for searching, retrieving, creating, editing, and deleting;
  • check parameters and field formats;
  • view response schemas and examples;
  • download the OpenAPI specification. The direct URL for the documentation is generated based on your account:

https://{your-account}.hannacrm.app/api/docs

API v4 base URL:

https://{your-account}.hannacrm.app/api/v4

OpenAPI YAML definition:

https://{your-account}.hannacrm.app/api/openapi.yaml

Always open the documentation using your account's domain. This ensures you see the modules, fields, and server address relevant to that specific account.

You can also use the centralized Hanna CRM API v4 reference in the public Hanna Help Center to find endpoints, parameters, authentication details, and request examples. This reference uses default.hannacrm.app as its base URL, so replace default with your Hanna account subdomain before sending a request. Use your account's /api/docs page when you need the exact modules and fields enabled for that account.

Where to find MCP documentation

Click MCP Documentation on the same page. It outlines the tools available to MCP clients, along with their purposes and parameters. Direct URL:

https://{your-account}.hannacrm.app/mcp/docs

The MCP documentation describes tools such as record search, retrieving a single record, and creating or updating records. These are not standard REST endpoints; instead, these actions are invoked by the MCP client.

YAML definition for MCP tools:

https://{your-account}.hannacrm.app/mcp/openapi.yaml

MCP documentation is separate from the Help Center's API documentation section. The latter contains the REST API v4 reference; always use your account's /mcp/docs page for MCP tools.

Differences between API and MCP

API v4 uses a key you generate and is suitable for system integrations, data exchange, and automated processes.

MCP uses OAuth authentication and allows a compatible MCP client to view and invoke "Hanna" tools based on granted permissions.

In both cases, the rules regarding CRM modules, team member, roles, and field visibility apply. If a field or module is disabled in the account, the integration may not be able to see it either.

Was this helpful?

Still need help? Ask the team