The State of Docs Report 2025 is live! Dive in and see why docs matter more than ever:
Read the report
PricingLog inSign up

Change request comments

Engage in threaded conversations on proposed changes.

This API powers the inline discussion around any new or updated documentation. Participate in comment threads and resolve them after reaching consensus.

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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-06-21T04:35:40.022Z",
      "updatedAt": "2025-06-21T04:35:40.022Z",
      "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-06-21T04:35:40.022Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

List all change request comments

get
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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:
formatstring · enumOptional

Output format for the content.

Possible values:
statusstring · enumOptional

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

Default: allPossible 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
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
      "editedAt": "2025-06-21T04:35:40.022Z",
      "reactions": [
        {
          "emoji": "text",
          "count": 1,
          "users": [
            {
              "user": {
                "object": "user",
                "id": "text",
                "displayName": "text",
                "email": "text",
                "photoURL": "text",
                "urls": {
                  "location": "https://example.com"
                }
              },
              "reactedAt": "2025-06-21T04:35:40.022Z"
            }
          ]
        }
      ],
      "replies": 1,
      "body": {
        "markdown": "text"
      },
      "target": {
        "node": {
          "id": "text",
          "preview": "text"
        },
        "changeRequest": "text",
        "review": "text",
        "page": {
          "id": "text",
          "title": "text",
          "emoji": "🎉",
          "icon": "gear",
          "createdAt": "2025-06-21T04:35:40.022Z",
          "updatedAt": "2025-06-21T04:35:40.022Z",
          "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-06-21T04:35:40.022Z",
      "resolvedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Create a change request comment

post
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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
POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "node": "text",
  "page": "text",
  "body": {
    "markdown": "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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-06-21T04:35:40.022Z",
      "updatedAt": "2025-06-21T04:35:40.022Z",
      "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-06-21T04:35:40.022Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Get a change request comment

get
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-06-21T04:35:40.022Z",
      "updatedAt": "2025-06-21T04:35:40.022Z",
      "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-06-21T04:35:40.022Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Update a change request comment

put
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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
PUT /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "replies": 1,
  "body": {
    "markdown": "text"
  },
  "target": {
    "node": {
      "id": "text",
      "preview": "text"
    },
    "changeRequest": "text",
    "review": "text",
    "page": {
      "id": "text",
      "title": "text",
      "emoji": "🎉",
      "icon": "gear",
      "createdAt": "2025-06-21T04:35:40.022Z",
      "updatedAt": "2025-06-21T04:35:40.022Z",
      "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-06-21T04:35:40.022Z",
  "resolvedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Delete a change request comment

delete
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Responses
205
The comment has been deleted.
delete
DELETE /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

The comment has been deleted.

No content

List all change request comment replies

get
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

formatstring · enumOptional

Output format for the content.

Possible values:
Responses
200
OK
application/json
Responseall of
get
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "comment-reply",
      "id": "text",
      "postedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "postedAt": "2025-06-21T04:35:40.022Z",
      "editedAt": "2025-06-21T04:35:40.022Z",
      "reactions": [
        {
          "emoji": "text",
          "count": 1,
          "users": [
            {
              "user": {
                "object": "user",
                "id": "text",
                "displayName": "text",
                "email": "text",
                "photoURL": "text",
                "urls": {
                  "location": "https://example.com"
                }
              },
              "reactedAt": "2025-06-21T04:35:40.022Z"
            }
          ]
        }
      ],
      "body": {
        "markdown": "text"
      },
      "urls": {
        "location": "https://example.com"
      },
      "permissions": {
        "view": true,
        "edit": true,
        "reply": true,
        "delete": true
      }
    }
  ]
}

Create a change request comment reply

post
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

Query parameters
formatstring · enumOptional

Output format for the content.

Possible values:
Body
bodyone ofRequired

The content of the comment.

or
or
object · EmptyOptional
Responses
200
The reply was posted.
application/json
post
POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Get a change request comment reply

get
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Update a change request comment reply

put
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

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 reply was updated.
application/json
put
PUT /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId} 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 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-06-21T04:35:40.022Z",
  "editedAt": "2025-06-21T04:35:40.022Z",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "user": {
            "object": "user",
            "id": "text",
            "displayName": "text",
            "email": "text",
            "photoURL": "text",
            "urls": {
              "location": "https://example.com"
            }
          },
          "reactedAt": "2025-06-21T04:35:40.022Z"
        }
      ]
    }
  ],
  "body": {
    "markdown": "text"
  },
  "urls": {
    "location": "https://example.com"
  },
  "permissions": {
    "view": true,
    "edit": true,
    "reply": true,
    "delete": true
  }
}

Delete a change request comment reply

delete
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in the space

commentIdstringRequired

The unique id of the comment

commentReplyIdstringRequired

The unique id of the comment reply

Responses
205
The comment has been deleted.
delete
DELETE /v1/spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
205

The comment has been deleted.

No content

List all users who commented in a CR

get
Authorizations
Path parameters
spaceIdstringRequired

The unique id of the space

changeRequestIdstringRequired

The unique ID of the change request or its number identifier in 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
GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/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-06-21T04:35:40.022Z",
      "lastSeenAt": "2025-06-21T04:35:40.022Z",
      "sso": true,
      "spaces": 1,
      "teams": 1
    }
  ]
}

Was this helpful?