Developers

Build on Mingoal.

A REST API, an MCP server, and a CLI — all backed by your club’s data. Generate an API key and automate events, members, posts, and more. Available on the Scale plan.

Quickstart

  1. In your club’s Settings → Developers, generate an API key. The secret is shown once — copy it.
  2. Send it as a bearer token on every request.
  3. Call the API, or wire up the MCP server / CLI below.
curl https://mingoal.com/api/v1/me \
  -H "Authorization: Bearer mg_live_xxx"

Authentication & format

Authenticate with Authorization: Bearer <key> (or the X-Api-Key header). Each key is scoped to one club, with read or read+write access.

  • Base URL: https://mingoal.com/api/v1
  • Lists return { items, total, limit, offset }; single items { item }.
  • Errors return { error: { code, message } }.
  • Pagination: ?limit= (1–100) and ?offset=.
  • Rate limit: 600 requests/hour per key (HTTP 429 when exceeded).

Endpoints

GET/meIdentify the key: club + scopes
GET/clubClub details
PATCH/clubUpdate club fields
GET/membersList members
GET/members/:idGet a member
PATCH/members/:idUpdate role / status
GET/eventsList events (?upcoming=true)
POST/eventsCreate an event
GET/events/:idGet an event
PATCH/events/:idUpdate an event
DELETE/events/:idDelete an event
GET/events/:id/rsvpsList RSVPs
POST/events/:id/rsvpsCreate an RSVP
GET/announcementsList announcements
POST/announcementsPost an announcement
GET/blogList blog posts
POST/blogCreate a blog post
GET/dealsList deals
POST/dealsCreate a deal
GET/productsList merch products
GET/feedList community feed posts
GET/galleryList albums / photos
# Create an event
curl -X POST https://mingoal.com/api/v1/events \
  -H "Authorization: Bearer mg_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"title":"Saturday Long Run","starts_at":"2026-07-04T08:00:00Z"}'

MCP server

The @mingoal/mcp-server package exposes the API as Model Context Protocol tools, so Claude Desktop (and any MCP client) can manage your club in natural language — list events, post announcements, create blog posts, and more.

Add it to your MCP client config with your API key:

{
  "mcpServers": {
    "mingoal": {
      "command": "mingoal-mcp",
      "env": { "MINGOAL_API_KEY": "mg_live_xxx" }
    }
  }
}

CLI

The @mingoal/cli package gives you a mingoal command to script your club from the terminal.

mingoal login mg_live_xxx
mingoal events list --upcoming
mingoal announcements create --title "Welcome" --body "We're live!"