beta · api · 0.1.0

List top-level Community Comments for one resource

GET /api/v1/community/comments

Capability Domain: Community Interaction

Authentication

projectCredential (comments:read)

Scope: comments:read

Parameters and request body

X-Correlation-ID — header, optional
X-Correlation-ID 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
}
```

limit — query, optional

limit schema

{
    "type": "integer",
    "minimum": 1,
    "maximum": 100,
    "default": 50
}

after — query, optional

after schema

{
    "type": "string",
    "format": "uuid"
}

Responses and errors

Status	Description
`200`	Client- and resource-scoped Community Comments
`401`	Invalid or revoked Project Credential
`403`	Project Credential lacks the required scope
`422`	Request violates the public contract

200 schema

200 response schema

{
    "type": "object",
    "required": [
        "data",
        "next_after"
    ],
    "properties": {
        "data": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "required": [
                    "id",
                    "platform_account_id",
                    "resource_type",
                    "resource_id",
                    "body",
                    "revision",
                    "removed_at",
                    "moderation_state",
                    "moderation_reason",
                    "created_at"
                ],
                "properties": {
                    "id": {
                        "type": "string",
                        "format": "uuid"
                    },
                    "parent_comment_id": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "uuid"
                    },
                    "platform_account_id": {
                        "type": "string",
                        "format": "uuid"
                    },
                    "resource_type": {
                        "type": "string"
                    },
                    "resource_id": {
                        "type": "string"
                    },
                    "body": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "revision": {
                        "type": "integer",
                        "minimum": 1
                    },
                    "removed_at": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "format": "date-time"
                    },
                    "moderation_state": {
                        "type": "string",
                        "enum": [
                            "visible",
                            "restricted"
                        ]
                    },
                    "moderation_reason": {
                        "type": [
                            "string",
                            "null"
                        ],
                        "enum": [
                            "spam",
                            "harassment",
                            "hate",
                            "violence",
                            "sexual_content",
                            null
                        ]
                    },
                    "created_at": {
                        "type": "string",
                        "format": "date-time"
                    }
                }
            }
        },
        "next_after": {
            "type": [
                "string",
                "null"
            ],
            "format": "uuid"
        }
    }
}

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": "51000000-0000-4000-8000-000000000001",
            "platform_account_id": "30000000-0000-4000-8000-000000000003",
            "resource_type": "article",
            "resource_id": "article-42",
            "body": "A useful comment.",
            "created_at": "2026-09-04T02:00:00Z"
        }
    ],
    "next_after": null
}

Idempotency

Safe read; repeated requests do not change Community Comments.