Skip to content
Betterfield logo - takes you back to the home page Betterfield Docs

API Reference

Overview

Section titled “Overview”

The Betterfield API follows REST conventions and is available at https://api.betterfield.pt/api/v1.

Authentication

Section titled “Authentication”

All endpoints (except /health and /auth) require a JWT token in the Authorization header:

Authorization: Bearer <token>

Health Check

Section titled “Health Check”
GET /api/v1/health

Returns the status of infrastructure services. Authentication is not required.