API Reference
API Reference
Every BioFlow /v1 operation — 22 endpoints with parameters, schemas, examples, and a request builder, rendered from the OpenAPI 3.1 spec.
The full BioFlow /v1 surface, rendered from the
OpenAPI 3.1 spec. Start with the
API documentation hub for auth, quotas, pagination, idempotency,
and the error registry.
| Operation | Endpoint | Scope |
|---|---|---|
| Get analytics summary | GET /v1/analytics/summary | analytics:read |
| List contacts | GET /v1/contacts | contacts:read |
| List files | GET /v1/files | files:read |
| List pages | GET /v1/pages | pages:read |
| Create a page | POST /v1/pages | pages:write |
| Delete a page | DELETE /v1/pages/{page_id} | pages:write |
| Get a page | GET /v1/pages/{page_id} | pages:read |
| Update a page draft | PATCH /v1/pages/{page_id} | pages:write |
| Add a block | POST /v1/pages/{page_id}/blocks | pages:write |
| Remove a block | DELETE /v1/pages/{page_id}/blocks/{block_id} | pages:write |
| Publish a page | POST /v1/pages/{page_id}/publish | publish |
| Get API usage | GET /v1/usage | pages:read, pages:write, analytics:read, contacts:read, files:read, publish |
| List webhook endpoints | GET /v1/webhook-endpoints | webhooks:read |
| Create a webhook endpoint | POST /v1/webhook-endpoints | webhooks:write |
| Delete a webhook endpoint | DELETE /v1/webhook-endpoints/{endpoint_id} | webhooks:write |
| Get a webhook endpoint | GET /v1/webhook-endpoints/{endpoint_id} | webhooks:read |
| Update a webhook endpoint | PATCH /v1/webhook-endpoints/{endpoint_id} | webhooks:write |
| List deliveries | GET /v1/webhook-endpoints/{endpoint_id}/deliveries | webhooks:read |
| Resend a delivery | POST /v1/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend | webhooks:write |
| Replay failed deliveries | POST /v1/webhook-endpoints/{endpoint_id}/replay | webhooks:write |
| Rotate the signing secret | POST /v1/webhook-endpoints/{endpoint_id}/rotate-secret | webhooks:write |
| Send a test event | POST /v1/webhook-endpoints/{endpoint_id}/test | webhooks:write |