GET /api/v1/comments

Retrieves a list of comments, with support for filtering by resource type, item, user, and content. Useful for both admin management and fetching comments for a specific profile.

Permissions

Query Parameters

Response

200 OK

Returns a paginated list of comment resources.

Schema

{
  "data": [
    { /* Comment Resource */ }
  ],
  "links": { /* Pagination Data */ },
  "meta": { /* Pagination Data */ }
}

Example

{
  "data": [
    {
      "id": 123,
      "user_id": 456,
      "commentable_type": "App\\Models\\Gyms\\Gym",
      "commentable_id": 42,
      "is_user_commentable_client": false,
      "content": "Great gym!",
      "parent_comment_id": null,
      "created_at": "2025-01-01 00:00:00",
      "updated_at": "2025-01-01 00:03:00"
    }
  ],
  "links": {
    "first": "https://api.example.com/api/v1/comments?page=1",
    "last": "https://api.example.com/api/v1/comments?page=10",
    "prev": null,
    "next": "https://api.example.com/api/v1/comments?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://api.example.com/api/v1/comments",
    "per_page": 50,
    "to": 50,
    "total": 500
  }
}

For a full schema, see Comment Resource and Pagination Data.

Error Responses