RedRover Logo

Reports

Get a Report

Returns one shared report with its sections.

GET/reports/{id}
Scope: reports:readAI Connector Tool: redrover_get_report

Headers

  • AuthorizationstringRequired

    Bearer followed by an rr_live_ API key or a connected app's access token. See Authentication.

  • X-Workspace-IdstringRequired

    The workspace to act on, from List Workspaces.

    UUID

Path Parameters

  • idstringRequired

    The report ID from List Reports

Response

200 The report.

  • dataobjectRequired
    Show 6 Child Fields
    • idstringRequired

      Report ID

      UUID

    • typestringRequired

      week-gameplan (the plan for a week), weekly-summary (what a week earned), monthly-report or performance-report

      one of week-gameplan, weekly-summary, monthly-report, performance-report

    • periodStartstringRequired

      First day the report covers, YYYY-MM-DD

    • periodEndstringRequired

      Last day the report covers, YYYY-MM-DD

    • createdAtdatetimeRequired

      When the report was made

    • contentobjectRequired

      The report's sections, as stored when it was shared with you: the plan, highlights, wins, figures and so on

Errors

Every error uses the error envelope.

  • 404No shared report with this ID in the workspace
  • 401The Authorization header is missing, or the key is invalid or revoked
  • 403The key lacks the endpoint's scope, or cannot reach the workspace
  • 429More than 120 requests in a minute. Wait for Retry-After seconds
  • 500Something went wrong on our side
curl "https://app.tryredrover.com/api/public/v1/reports/4b7c1e2a-9d3f-4a5b-8c6d-7e8f9a0b1c2d" \
  -H "Authorization: Bearer $REDROVER_API_KEY" \
  -H "X-Workspace-Id: $REDROVER_WORKSPACE_ID"
200 Response
{
  "data": {
    "id": "4b7c1e2a-9d3f-4a5b-8c6d-7e8f9a0b1c2d",
    "type": "weekly-summary",
    "periodStart": "2026-11-09",
    "periodEnd": "2026-11-15",
    "createdAt": "2026-11-15T14:00:00Z",
    "content": {
      "fridayUpdate": {
        "highlights": [
          "Two posts reached the top of r/startups this week"
        ],
        "closingThought": "Next week we lean into the pricing questions."
      }
    }
  }
}