Browse Community Interaction

beta · api · 0.1.0

Retrieve one structured Comment report

GET /api/v1/community/comments/{commentId}/reports/{reportId}

Capability Domain: Community Interaction

Authentication

projectCredential (reports:read)

Scope: reports:read

Parameters and request body

  • X-Correlation-ID — header, optional
    X-Correlation-ID schema
    {
        "type": "string",
        "format": "uuid"
    }
  • commentId — path, required
    commentId schema
    {
        "type": "string",
        "format": "uuid"
    }
  • reportId — path, required
    reportId schema
    {
        "type": "string",
        "format": "uuid"
    }
  • resource_type — query, required
    resource_type schema
    {
        "type": "string",
        "maxLength": 120
    }
  • resource_id — query, required
    resource_id schema
    {
        "type": "string",
        "maxLength": 255
    }

Responses and errors

StatusDescription
200Received report status without reporter identity
401Invalid or revoked Project Credential
403Project Credential lacks the required scope
422Request violates the public contract

200 schema

200 response schema
{
    "type": "object",
    "required": [
        "data"
    ],
    "properties": {
        "data": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "id",
                "comment_id",
                "reason",
                "status",
                "decision",
                "decided_at",
                "created_at"
            ],
            "properties": {
                "id": {
                    "type": "string",
                    "format": "uuid"
                },
                "comment_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "reason": {
                    "type": "string",
                    "enum": [
                        "spam",
                        "harassment",
                        "hate",
                        "violence",
                        "sexual_content"
                    ]
                },
                "status": {
                    "type": "string",
                    "enum": [
                        "received",
                        "resolved"
                    ]
                },
                "decision": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "enum": [
                        "no_action",
                        "restricted",
                        null
                    ]
                },
                "decided_at": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "format": "date-time"
                },
                "created_at": {
                    "type": "string",
                    "format": "date-time"
                }
            }
        }
    }
}

401 schema

401 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

403 schema

403 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

422 schema

422 response schema
{
    "type": "object",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "type": "object",
            "required": [
                "code",
                "message",
                "retryable",
                "correlation_id",
                "details"
            ],
            "properties": {
                "code": {
                    "type": "string"
                },
                "message": {
                    "type": "string"
                },
                "retryable": {
                    "type": "boolean"
                },
                "correlation_id": {
                    "type": "string",
                    "format": "uuid"
                },
                "details": {
                    "type": "object"
                }
            }
        }
    }
}

200 example

200 response example
{
    "data": {
        "id": "53000000-0000-4000-8000-000000000001",
        "comment_id": "51000000-0000-4000-8000-000000000001",
        "reason": "spam",
        "status": "received",
        "created_at": "2026-09-07T02:00:00Z"
    }
}

Idempotency

Safe read; repeated requests do not change report status.