Space comments

Integrate and manage user comments in a space.

Comments are a powerful way to gather feedback on your documentation. Use this API to post, list, update, or delete comments and keep conversations organized.

The Comment object

Attributes

all ofOptional

and

one ofOptional

or

The Comment object

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "tableCell": {
      "record": "text",
      "definition": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-08-26T22:08:41.460Z",
      "updatedAt": "2025-08-26T22:08:41.460Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  },
  "status": "resolved",
  "resolvedAt": "2025-08-26T22:08:41.460Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

List all space comments

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

orderstring · enumOptional

An order for the items in the list

Default: descPossible values:

statusstring · enumOptional

When provided, only comments with the given status are returned. Defaults to "all".

Default: allPossible values:

formatstring · enumOptional

Output format for the content.

Possible values:

targetPagestringOptional

The target page of the comment

authorsstring[]Optional

User IDs to filter queried comments on

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "comment",
      "id": "text",
      "postedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "postedAt": "2025-08-26T22:08:41.460Z",
      "editedAt": "2025-08-26T22:08:41.460Z",
      "reactions": [
        {
          "emoji": "text",
          "count": 1,
          "users": [
            {
              "user": {
                "object": "user",
                "id": "text",
                "displayName": "text",
                "email": "text",
                "photoURL": "text",
                "urls": {
                  "location": "https://example.com"
                }
              },
              "reactedAt": "2025-08-26T22:08:41.460Z"
            }
          ]
        }
      ],
      "replies": 1,
      "body": {
        "markdown": "text"
      },
      "target": {
        "node": {
          "id": "text",
          "preview": "text"
        },
        "tableCell": {
          "record": "text",
          "definition": "text"
        },
        "changeRequest": "text",
        "review": "text",
        "page": {
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "icon": "gear",
          "createdAt": "2025-08-26T22:08:41.460Z",
          "updatedAt": "2025-08-26T22:08:41.460Z",
          "path": "text",
          "outdated": true
        },
        "space": "text",
        "revision": "text"
      },
      "urls": {
        "location": "https://example.com"
      },
      "permissions": {
        "view": true,
        "edit": true,
        "reply": true,
        "delete": true
      },
      "status": "resolved",
      "resolvedAt": "2025-08-26T22:08:41.460Z",
      "resolvedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Create a space comment

post

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Body

nodestringOptional

The node to which the comment is posted, if any.

pagestringOptional

The page to which the comment is posted, if any.

bodyone ofRequired

The content of the comment.

or

or

object · EmptyOptional

Responses

200

The comment was posted.

application/json

Responseall of

and

one ofOptional

or

post

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "node": "text",
  "page": "text",
  "body": {
    "markdown": "text"
  },
  "tableCell": {
    "record": "text",
    "definition": "text"
  }
}

200

The comment was posted.

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "tableCell": {
      "record": "text",
      "definition": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-08-26T22:08:41.460Z",
      "updatedAt": "2025-08-26T22:08:41.460Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  },
  "status": "resolved",
  "resolvedAt": "2025-08-26T22:08:41.460Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Get a space comment

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment.

application/json

Responseall of

and

one ofOptional

or

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The returned comment.

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "tableCell": {
      "record": "text",
      "definition": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-08-26T22:08:41.460Z",
      "updatedAt": "2025-08-26T22:08:41.460Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  },
  "status": "resolved",
  "resolvedAt": "2025-08-26T22:08:41.460Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Update a space comment

put

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Body

resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

or

or

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The comment was updated.

application/json

Responseall of

and

one ofOptional

or

put

HTTPcURLJavaScriptPython

PUT /v1/spaces/{spaceId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "resolved": true,
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

200

The comment was updated.

{
  "object": "comment",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "tableCell": {
      "record": "text",
      "definition": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-08-26T22:08:41.460Z",
      "updatedAt": "2025-08-26T22:08:41.460Z",
      "path": "text",
      "outdated": true
    },
    "space": "text",
    "revision": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  },
  "status": "resolved",
  "resolvedAt": "2025-08-26T22:08:41.460Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Delete a space comment

delete

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Responses

204

Comment did not exist.

205

The comment has been deleted.

delete

HTTPcURLJavaScriptPython

DELETE /v1/spaces/{spaceId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create a space comment reply

post

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

Body

bodyone ofRequired

The content of the comment.

or

or

object · EmptyOptional

Responses

200

The reply was posted.

application/json

post

HTTPcURLJavaScriptPython

POST /v1/spaces/{spaceId}/comments/{commentId}/replies HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "body": {
    "markdown": "text"
  }
}

200

The reply was posted.

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Get a space comment reply

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

Responses

200

The returned comment reply.

application/json

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The returned comment reply.

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Update a space comment reply

put

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Body

bodyone ofOptional

Content of the comment.

or

or

object · EmptyOptional

addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses

200

The reply was updated.

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "body": {
    "markdown": "text"
  },
  "addedReactions": [
    "text"
  ],
  "removedReactions": [
    "text"
  ]
}

200

The reply was updated.

{
  "object": "comment-reply",
  "id": "text",
  "postedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "postedAt": "2025-08-26T22:08:41.460Z",
  "editedAt": "2025-08-26T22:08:41.460Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-08-26T22:08:41.460Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Delete a space comment reply

delete

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Responses

204

Comment reply did not exist.

205

The comment has been deleted.

delete

HTTPcURLJavaScriptPython

DELETE /v1/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List all users who commented in a space

get

Authorizations

Path parameters

spaceIdstringRequired

The unique id of the space

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

Responseall of

get

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/commenters HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "member",
      "id": "text",
      "role": "admin",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "disabled": true,
      "joinedAt": "2025-08-26T22:08:41.460Z",
      "lastSeenAt": "2025-08-26T22:08:41.460Z",
      "sso": true,
      "spaces": 1,
      "teams": 1
    }
  ]
}