EvoHub DocsEvoHub Docs Sign in

Retro API

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs https://docs.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs": {
      "url": "https://docs.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs": {
      "type": "http",
      "url": "https://docs.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

Version 1.0 OpenAPI 3.1.0

Run EvoHub Retro from scripts and integrations: create retro boards, shape their columns, add and moderate cards, vote, react and comment, track action items, control a board's shared timer and sharing, export a board to PDF, and read retro analytics and the audit log.

Authentication. Every endpoint takes an EvoHub API key, sent as Authorization: Bearer evohub_… or as X-API-Key: evohub_…. Each operation names the scope the key needs in its description and in x-evohub-permission. A missing or invalid key gets 401; a valid key without the scope gets 403, never 401. A key holds exactly its scopes: it is never treated as an administrator. See the API overview, API keys and scopes and Errors.

Responses. A successful answer carries "success": true and its result in data. Errors carry "success": false and an error object with a machine-readable code and, usually, the request_id to quote to support. Timestamps are RFC 3339 in UTC.

Who sees a board. A board belongs to the whole organization (team_id is "") or to one team, and its visibility says who sees it without being named on it: org (everyone), team (that team) or private (nobody). People named on a board, and teams the board was shared with, see it whatever its visibility. An organization key sees as its team; a personal key sees as the person who made it. A board the caller cannot see answers 404 NOT_FOUND, exactly like one that does not exist.

Closed boards. Closing a retro freezes it: columns, cards, comments, reactions, votes, action items and the timer can no longer be changed, and those writes answer 409 BOARD_CLOSED. A closed board can still be read, renamed, reconfigured, reshared, reopened and deleted.

Anonymity. Cards and comments never say who wrote them. The author is kept only to decide who may edit or delete them: content a key writes is the key's own (a personal key's is its person's), and changing anyone else's needs retro:board:write.

Share links. Guests who open a board's share link use the board through the web app, with the link as their credential. This reference is for API-key callers; see Retro boards for share links.

Servers

  • https://evohub.io

Authentication

  • bearerKey HTTP Bearer
    An EvoHub API key (evohub_…) as a bearer token.
  • headerKey API key in the header X-API-Key
    An EvoHub API key (evohub_…).

Boards

Create, list, read, change, close, reopen and delete retro boards.

GET/api/v1/retro/boardsList boards
POST/api/v1/retro/boardsCreate a board
GET/api/v1/retro/boards/{boardID}Get a board
DELETE/api/v1/retro/boards/{boardID}Delete a board
PATCH/api/v1/retro/boards/{boardID}Rename or move a board
POST/api/v1/retro/boards/{boardID}/closeClose a board
POST/api/v1/retro/boards/{boardID}/reopenReopen a board

Sharing

The people and teams a board is shared with, and its share link.

GET/api/v1/retro/boards/{boardID}/membersList who a board is shared with
POST/api/v1/retro/boards/{boardID}/membersAdd a person to a board
DELETE/api/v1/retro/boards/{boardID}/members/{userID}Remove a person from a board
PATCH/api/v1/retro/boards/{boardID}/shareSet the share mode
POST/api/v1/retro/boards/{boardID}/share/rotateRotate the share link
POST/api/v1/retro/boards/{boardID}/teamsShare a board with a team
DELETE/api/v1/retro/boards/{boardID}/teams/{teamID}Stop sharing a board with a team

Facilitation

A board's settings and its shared countdown timer.

PATCH/api/v1/retro/boards/{boardID}/settingsChange a board's settings
POST/api/v1/retro/boards/{boardID}/timerControl the board's timer

Columns

The columns that give a board its shape.

POST/api/v1/retro/boards/{boardID}/columnsAdd a column
DELETE/api/v1/retro/boards/{boardID}/columns/{columnID}Delete a column
PATCH/api/v1/retro/boards/{boardID}/columns/{columnID}Change a column

Cards

Cards, and the comments, reactions and votes on them.

POST/api/v1/retro/boards/{boardID}/cards/mergeMerge cards
DELETE/api/v1/retro/boards/{boardID}/cards/{cardID}Delete a card
PATCH/api/v1/retro/boards/{boardID}/cards/{cardID}Edit a card
POST/api/v1/retro/boards/{boardID}/cards/{cardID}/commentsComment on a card
DELETE/api/v1/retro/boards/{boardID}/cards/{cardID}/comments/{commentID}Delete a comment
POST/api/v1/retro/boards/{boardID}/cards/{cardID}/reactionsAdd or remove a reaction
POST/api/v1/retro/boards/{boardID}/cards/{cardID}/votesVote on a card
POST/api/v1/retro/boards/{boardID}/columns/{columnID}/cardsAdd a card

Action items

What the team agreed to do, with owners and due dates.

GET/api/v1/retro/action-items/mineList my open action items
GET/api/v1/retro/boards/{boardID}/action-itemsList a board's action items
POST/api/v1/retro/boards/{boardID}/action-itemsAdd an action item
DELETE/api/v1/retro/boards/{boardID}/action-items/{itemID}Delete an action item
PATCH/api/v1/retro/boards/{boardID}/action-items/{itemID}Update an action item

Export

A board as a PDF.

GET/api/v1/retro/boards/{boardID}/exportExport a board as PDF

Analytics

Summary counts and retro analytics across the boards you can see.

GET/api/v1/retro/analyticsGet retro analytics
GET/api/v1/retro/statsGet board counts

Audit log

Who changed what in Retro.

GET/api/v1/retro/audit-logsList audit log entries