GET/spaces/api/v1/spaces/{spaceID}/pages/{pageID}/comments.json

get all comments for a page

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
  • Code
    404
    Type
    object
    Schema
    Description
    404 Not Found
  • Code
    500
    Type
    object
    Schema
    Description
    500 Internal Server Error

Examples

200 OK

CommentParent
{
  "comments": [
    {
      "comment": {
        "content": "string",
        "createdAt": "2024-07-19T16:54:24.204Z",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "deletedAt": "2024-07-19T16:54:24.204Z",
        "deletedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "id": 0,
        "identifier": "string",
        "isPrivate": true,
        "page": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "parentId": 0,
        "reactions": {
          "counts": {},
          "userReactionId": 0
        },
        "selection": "string",
        "space": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "state": "string",
        "updatedAt": "2024-07-19T16:54:24.204Z",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      },
      "replies": [
        {
          "comment": {
            "content": "string",
            "createdAt": "2024-07-19T16:54:24.204Z",
            "createdBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "deletedAt": "2024-07-19T16:54:24.204Z",
            "deletedBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "id": 0,
            "identifier": "string",
            "isPrivate": true,
            "page": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "parentId": 0,
            "reactions": {
              "counts": {},
              "userReactionId": 0
            },
            "selection": "string",
            "space": {
              "id": 0,
              "meta": {},
              "type": "string"
            },
            "state": "string",
            "updatedAt": "2024-07-19T16:54:24.204Z",
            "updatedBy": {
              "id": 0,
              "meta": {},
              "type": "string"
            }
          }
        }
      ]
    }
  ]
}