RedRover Logo

Reports

List Reports

Lists the reports shared with you, newest first.

GET/reports
Scope: reports:readAI Connector Tool: redrover_list_reports

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

Query Parameters

  • limitinteger

    How many results to return, 1 to 100 (default 25)

    1 to 100 · default 25

  • offsetinteger

    How many results to skip (default 0)

    default 0

  • typestring

    Only this kind: week-gameplan, weekly-summary, monthly-report or performance-report

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

Response

200 A page of reports.

  • dataobject[]Required
    Show 5 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

  • paginationobjectRequired
    Show 3 Child Fields
    • limitintegerRequired

      Page size used for this response

    • offsetintegerRequired

      How many results were skipped

    • hasMorebooleanRequired

      True when more results follow at a higher offset

Errors

Every error uses the error envelope.

  • 400type, limit or offset is not valid
  • 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?type=weekly-summary&limit=25" \
  -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"
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "hasMore": false
  }
}