CyberRXN Docs
APIAPI reference

List reports visible to this workspace or staff reviewer

GET /v1/reports

GET /v1/reports

API overview · OpenAPI

Workspace-scoped by default. reviewer=true is restricted to verified designated CyberRXN staff and opens the cross-workspace review queue. Owners/admins are not staff reviewers.

Authorization

This operation requires a bearer credential. The description defines additional role, scope or first-party-session restrictions; an API key does not grant those permissions by itself.

Parameters

PropertyTypeRequiredDetails
status (query)"pending" ∣ "accepted" ∣ "rejected" ∣ "needs_information" ∣ "needs_revalidation" ∣ nullno
limit (query)integerno
offset (query)integerno
reviewer (query)booleanno

Request body

No request body.

Responses

HTTPDetailsType
200Successful Responseapplication/json: ObservationReportList
401Unauthorizedapplication/problem+json: ProblemDetails
403Forbiddenapplication/problem+json: ProblemDetails
404Not Foundapplication/problem+json: ProblemDetails
409Conflictapplication/problem+json: ProblemDetails
413Request Entity Too Largeapplication/problem+json: ProblemDetails
422Unprocessable Entityapplication/problem+json: ProblemDetails
429Too Many Requestsapplication/problem+json: ProblemDetails
502Bad Gatewayapplication/problem+json: ProblemDetails
503Service Unavailableapplication/problem+json: ProblemDetails

Response: ObservationReportList

PropertyTypeRequiredDetails
reportsObservationReport[]yes
totalintegeryes
limitintegeryes
offsetintegeryes
Full schema
{
  "properties": {
    "reports": {
      "items": {
        "$ref": "#/components/schemas/ObservationReport"
      },
      "type": "array",
      "title": "Reports"
    },
    "total": {
      "type": "integer",
      "title": "Total"
    },
    "limit": {
      "type": "integer",
      "title": "Limit"
    },
    "offset": {
      "type": "integer",
      "title": "Offset"
    }
  },
  "additionalProperties": true,
  "type": "object",
  "required": [
    "reports",
    "total",
    "limit",
    "offset"
  ],
  "title": "ObservationReportList"
}

This page is generated from OpenAPI; examples are schemas, not a fabricated successful response.

Usage and billing · Structured errors

On this page