Endpoint index

This page lists every MedFlow API endpoint, grouped by resource. All paths are relative to the base URL, every call authenticates with an API key (Authorization: Bearer $MEDFLOW_API_KEY), and the scopes each group needs are shown alongside it.

Jump: Identity · Search · Queries · Diagrams · Triggers · Runs · Webhooks

---

Identity

No scope required.

Method	Path	Summary
GET	/v1/me	Verify the key and return its tenant, workspace, and scopes

Details: Verify a key

---

Search

Scope: search:read

Method	Path	Summary
POST	/v1/search	Find patients, pathways, or practitioners
POST	/v1/search/count	Count matches only

Details: Search

---

Queries

Scopes: queries:read / queries:write

Method	Path	Scope	Summary
POST	/v1/queries	queries:write	Create a query
GET	/v1/queries	queries:read	List queries
GET	/v1/queries/:queryId	queries:read	Get a query
PATCH	/v1/queries/:queryId	queries:write	Update a query
DELETE	/v1/queries/:queryId	queries:write	Delete a query

Details: Queries

---

Diagrams

Scope: diagrams:read

Method	Path	Summary
GET	/v1/diagrams	List diagrams
GET	/v1/diagrams/:id	Get a diagram

Details: Diagrams

---

Triggers

Scopes: triggers:read / triggers:write (management). Firing uses runs:write.

Method	Path	Scope	Summary
POST	/v1/triggers/:triggerId	runs:write	Fire a trigger (start a run)
POST	/v1/triggers	triggers:write	Create a trigger
GET	/v1/triggers	triggers:read	List triggers
GET	/v1/triggers/:triggerId	triggers:read	Get a trigger
PATCH	/v1/triggers/:triggerId	triggers:write	Update a trigger
DELETE	/v1/triggers/:triggerId	triggers:write	Delete a trigger

Details: Triggers

---

Runs

Scopes: runs:read / runs:write

Runs are created by firing a trigger, not by POSTing to /v1/runs.

Method	Path	Scope	Summary
GET	/v1/runs	runs:read	List runs (filter by triggerId)
GET	/v1/runs/:runId	runs:read	Get a run
POST	/v1/runs/:runId/start	runs:write	Start a queued run (play)
POST	/v1/runs/:runId/cancel	runs:write	Cancel a run
POST	/v1/runs/:runId/pause	runs:write	Pause a run
POST	/v1/runs/:runId/resume	runs:write	Resume a paused run
GET	/v1/triggers/:triggerId/status	runs:read	Aggregate status for a trigger

Details: Runs

---

Webhooks

Scopes: webhooks:read / webhooks:write (management). Inbound delivery uses the webhook’s own secret.

Method	Path	Summary
GET	/v1/webhooks	List webhook endpoints
POST	/v1/webhooks	Create a webhook endpoint
GET	/v1/webhooks/:webhookId	Get a webhook
PATCH	/v1/webhooks/:webhookId	Update a webhook
DELETE	/v1/webhooks/:webhookId	Delete a webhook
POST	/v1/webhooks/:webhookId	Deliver data (MedFlow raises events and starts runs)

Details: Webhooks

---

Metrics

A read API for metric values is in development. Metrics are configured and viewed in the MedFlow product today.