Skip to main content
Mizu CRM
API Reference

Build on Mizu CRM

A comprehensive REST API to integrate, automate, and extend Mizu CRM across your entire stack.

Get API keyOpen raw spec

Authentication

Authenticate with bearer API keys issued from your workspace settings.

Core Resources

Manage leads, contacts, deals, and conversion workflows from one API surface.

Public Contract Signing

Use tokenized public endpoints for signer review and electronic execution.

Conversion Flows

Promote qualified leads into accounts, contacts, and opportunities with auditability.

Tenant Isolation

Endpoints are scoped by organization and backed by server-side authorization middleware.

OpenAPI Export

Fetch a raw machine-readable spec to generate SDKs, mocks, and integration tests.

Quick start

create-contact.jsJavaScript
// Partner API v1 — same origin as the app (not a separate api.* host)
const response = await fetch('/api/v1/contacts', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Ada Lovelace',
    email: 'you@company.com',
    company: 'your_company'
  })
});

const contact = await response.json();

Spec summary

OpenAPI version
3.1.0
Documented endpoints
23
Auth scheme
Bearer API key

Endpoints

Generated from in-repo spec
GET/api/v1/contactsList contacts (partner v1)
Partner v1 — Contacts
POST/api/v1/contactsCreate contact (partner v1)
Partner v1 — Contacts
GET/api/v1/contacts/{id}Get contact by ID (partner v1)
Partner v1 — Contacts
PATCH/api/v1/contacts/{id}Update contact (partner v1)
Partner v1 — Contacts
DELETE/api/v1/contacts/{id}Delete contact (partner v1)
Partner v1 — Contacts
GET/api/v1/leadsList leads (partner v1)
Partner v1 — Leads
POST/api/v1/leadsCreate lead (partner v1)
Partner v1 — Leads
GET/api/v1/dealsList deals (partner v1)
Partner v1 — Deals
POST/api/v1/dealsCreate deal (partner v1)
Partner v1 — Deals
GET/api/v1/webhooksList outbound webhook subscriptions (partner v1)
Partner v1 — Webhooks
POST/api/v1/webhooksRegister outbound webhook (partner v1)
Partner v1 — Webhooks
GET/api/v1/webhooks/{id}Get outbound webhook (partner v1)
Partner v1 — Webhooks
DELETE/api/v1/webhooks/{id}Delete outbound webhook (partner v1)
Partner v1 — Webhooks
GET/api/contactsList contacts (session CRM)
Session CRM — Contacts
POST/api/contactsCreate contact (session CRM)
Session CRM — Contacts
GET/api/contacts/{id}Get contact (session CRM)
Session CRM — Contacts
PATCH/api/contacts/{id}Update contact (session CRM)
Session CRM — Contacts
DELETE/api/contacts/{id}Soft-delete contact (session CRM)
Session CRM — Contacts
GET/api/contracts/sign/{token}Fetch public signature request payload
Public — ContractsPublic
POST/api/contracts/sign/{token}Submit a public contract signature
Public — ContractsPublic
GET/api/openapiThis OpenAPI document
MetaPublic
GET/api/data-portabilityData portability actions metadata
Portability
POST/api/data-portabilityFull / scoped / async portable export
Portability

Need help with your integration?

Our developer support team is here to help you ship faster.

Contact developer support
    CRM API Documentation - Mizu CRM