Skip to content
DotCollective Tools

Scorecards API

Endpoints

Section titled “Endpoints”

GET /api/scorecards

Section titled “GET /api/scorecards”

List scorecards, scoped by the user’s access level.

Permission: view:scorecards

Query params: ?week_of=2026-03-02&user_id=usr_abc123

POST /api/scorecards

Section titled “POST /api/scorecards”

Create a new scorecard.

Permission: update:scorecards

Body:

{
  "squad_name": "Squad Alpha",
  "week_of": "2026-03-02",
  "notes": "Good week overall"
}

GET /api/scorecards/:id

Section titled “GET /api/scorecards/:id”

Get a scorecard with all associated data (scores, KPIs, metrics).

Permission: view:scorecards

PUT /api/scorecards/:id

Section titled “PUT /api/scorecards/:id”

Update a scorecard and its associated data.

Permission: update:scorecards

DELETE /api/scorecards/:id

Section titled “DELETE /api/scorecards/:id”

Delete a scorecard and all associated data.

Permission: update:scorecards