MatterRef
Developer Platform

Build on MatterRef.

A versioned REST API over the same domain code the product uses. Fetch records, trigger workflows, and stream changes to your systems with signed webhooks.

Get started Read the docs 
# 1. Create an API key in the app (Admin), then call the API.
curl https://matterref.dev/v1/documents \
  -H "Authorization: Bearer mr_sk_…"

# 2. Register a webhook to receive signed events.
curl -X POST https://matterref.dev/v1/webhooks \
  -H "Authorization: Bearer mr_sk_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/matterref","event_types":["*"]}'

One API, one contract

The API is the pipe — the structured record and workflow engine are the product.

📡

REST + JSON

Versioned from day one (/v1/…). Reads delegate to the same store the UI uses — no parallel logic.

 🔑

Scoped API keys

Bearer tokens (mr_sk_…) returned once and stored only as a hash. Scope per org, per capability.

 🔔

Signed webhooks

Outbox-first delivery with retry/backoff, HMAC-SHA256 signatures, and a self-serve delivery log.

 🧭

OpenAPI spec

Contract-first: live spec at /openapi.json, Swagger at /docs.

API reference

The /v1 surface. Full details and examples live in the docs.

MethodPathDescriptionScope
GET/v1/stateFull filing state for the key's orgrecords:read
GET/v1/documentsList documents (filterable)records:read
GET/v1/documents/{id}Fetch one document by MatterRef numberrecords:read
GET/v1/clientsList clientsrecords:read
GET/v1/mattersList mattersrecords:read
GET/v1/setsList setsrecords:read
POST/v1/documentsIssue a document (file into the repository)records:write
PATCH/v1/documents/{id}Update mutable fieldsrecords:write
POST/v1/clients · /v1/matters · /v1/setsCreate filing structurerecords:write
POST/v1/inbound · /v1/inbound/fileCapture and file inbound recordsrecords:write
POST/v1/workflows/{id}/runStart a workflow runworkflows:trigger
POST/v1/webhooksRegister an outbound webhookwebhooks:manage
POST/v1/webhooks/{id}/testSend a live test eventwebhooks:manage

Scopes

Each key is granted a subset of capabilities. A key can never mint or revoke keys.

ScopeGrants
records:readRead state, documents, clients, matters, sets
records:writeCreate/update records, file inbound captures
workflows:triggerStart a workflow run
webhooks:manageManage webhook endpoints, view deliveries, send tests