LoadFlow Reminders API

Quick Start

Register a user or create an API key, then call the API with either a JWT (Bearer) or X-API-Key header. Reminders are sent automatically before and after the expiration date (30, 14, 7, 3, 1, 0 days before; then 7 and 30 days after).

• Register to get a user account and JWT.
• Or create an API key from the dashboard for server-to-server calls.
• Use the Swagger UI to try endpoints live.

Authentication

Every request (except GET /health and POST /auth/register, POST /auth/login) must include one of:

Authorization: Bearer YOUR_ACCESS_TOKEN

X-API-Key: YOUR_API_KEY

To obtain a JWT, register and then POST /auth/login with email and password.

Never expose API keys or tokens in frontend code. Use them only in server-side or trusted environments.

Reminders API

All reminder endpoints are under /reminders. You only see and manage reminders that belong to your user or API key.

• GET /reminders

  List all reminders for the authenticated user or API key. Optional: ?active_only=true

  fetch("https://api.loadflowlogistics.com/reminders", {
    headers: { "Authorization": "Bearer YOUR_JWT" }
  })

  Copy endpoint
• POST /reminders

  Create a new reminder. Body: name, email, expires_on (YYYY-MM-DD), enabled (optional, default true).

  fetch("https://api.loadflowlogistics.com/reminders", {
    method: "POST",
    headers: { "Authorization": "Bearer YOUR_JWT", "Content-Type": "application/json" },
    body: JSON.stringify({
      name: "Driver License",
      email: "user@example.com",
      expires_on: "2026-12-31",
      enabled: true
    })
  })

  Copy endpoint
• GET /reminders/{reminder_id}

  Get a reminder's status: last_sent_at, next_scheduled_fire, and details.

  fetch("https://api.loadflowlogistics.com/reminders/1", {
    headers: { "Authorization": "Bearer YOUR_JWT" }
  })

  Copy endpoint
• PUT /reminders/{reminder_id}

  Update a reminder's expiration date. Body: { expires_on: "YYYY-MM-DD" }.

  fetch("https://api.loadflowlogistics.com/reminders/1", {
    method: "PUT",
    headers: { "Authorization": "Bearer YOUR_JWT", "Content-Type": "application/json" },
    body: JSON.stringify({ expires_on: "2027-01-15" })
  })

  Copy endpoint
• POST /reminders/{reminder_id}/disable

  Disable a reminder (stops future email alerts).

  fetch("https://api.loadflowlogistics.com/reminders/1/disable", {
    method: "POST",
    headers: { "Authorization": "Bearer YOUR_JWT" }
  })

  Copy endpoint
• GET /reminders/{reminder_id}/logs

  Get send/failure logs for a reminder.

  fetch("https://api.loadflowlogistics.com/reminders/1/logs", {
    headers: { "Authorization": "Bearer YOUR_JWT" }
  })

  Copy endpoint

Auth endpoints

POST /auth/register — body: email, password, optional full_name. Returns user object.
POST /auth/login — body: email, password. Returns access_token, token_type, user.

Health

No authentication required.

GET https://api.loadflowlogistics.com/health

Returns { "status": "healthy", "timestamp": "..." }.

Error Handling

Errors return JSON with a detail field (string or array of validation errors).

• 400 — Bad request (e.g. validation error on body).
• 401 — Missing or invalid token/API key.
• 403 — Valid auth but not allowed to access this resource (e.g. another user's reminder).
• 404 — Reminder or resource not found.
• 422 — Unprocessable entity (e.g. invalid date format).

{
  "detail": "Reminder 99 not found"
}

Code Examples

Create a reminder (curl)

curl -X POST "https://api.loadflowlogistics.com/reminders" \
  -H "Authorization: Bearer YOUR_JWT" \
  -H "Content-Type: application/json" \
  -d '{"name":"Insurance","email":"you@example.com","expires_on":"2026-12-31","enabled":true}'

List reminders (JavaScript)

const res = await fetch("https://api.loadflowlogistics.com/reminders", {
  headers: { "Authorization": "Bearer " + token }
});
const reminders = await res.json();

Try in Swagger

The full interactive API reference with try-it-now is available via Swagger UI. Open the link below, authorize with your JWT or API key, and call any endpoint.

Also: https://api.loadflowlogistics.com/openapi.json for the OpenAPI schema.

Support

Need help integrating the Reminders API? Contact support or explore more resources:

• Contact
• Dashboard — manage reminders and API keys
• Swagger UI — try the API live