Change request reviewers

Assign or list requested reviewers for a change request.

Ensure quality by requesting and tracking reviewer feedback in your GitBook flow. This endpoint helps orchestrate the entire review cycle.

The ChangeRequestRequestedReviewer object

Attributes

all ofOptional

and

one ofOptional

The ChangeRequestRequestedReviewer object

{
  "object": "change-request-requested-reviewer",
  "revision": "text",
  "requestedBy": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  },
  "createdAt": "2025-08-26T23:19:07.272Z",
  "kind": "user",
  "user": {
    "object": "user",
    "id": "text",
    "displayName": "text",
    "email": "text",
    "photoURL": "text",
    "urls": {
      "location": "https://example.com"
    }
  }
}

Get all change request reviewers

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

A list of requested reviewers

application/json

Responseall of

get

GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A list of requested reviewers

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request-requested-reviewer",
      "revision": "text",
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2025-08-26T23:19:07.272Z",
      "kind": "user",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Request change request reviewers

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

usersstring[]Required

An array of user ids that will be requested.

subjectstringOptional

Optionally, update the subject of the change request when requesting reviewers.

Responses

200

The requests have successfully been sent.

application/json

post

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "users": [
    "text"
  ],
  "subject": "text"
}

200

The requests have successfully been sent.

{
  "users": [
    {
      "object": "change-request-requested-reviewer",
      "revision": "text",
      "requestedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2025-08-26T23:19:07.272Z",
      "kind": "user",
      "user": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      }
    }
  ]
}

Remove a reviewer from a change request

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

userIdstringRequired

The unique ID of the User

Responses

204

Reviewer was not found

205

The reviewer has been removed from the change request

delete

DELETE /v1/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers/{userId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Was this helpful?

{ "object": "change-request-requested-reviewer", "revision": "text", "requestedBy": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } }, "createdAt": "2025-08-26T23:19:07.272Z", "kind": "user", "user": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } } }

{ "next": { "page": "text" }, "count": 1, "items": [ { "object": "change-request-requested-reviewer", "revision": "text", "requestedBy": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } }, "createdAt": "2025-08-26T23:19:07.272Z", "kind": "user", "user": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } } } ] }

POST /v1/spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers HTTP/1.1 Host: api.gitbook.com Authorization: Bearer YOUR_SECRET_TOKEN Content-Type: application/json Accept: */* Content-Length: 35 { "users": [ "text" ], "subject": "text" }

{ "users": [ { "object": "change-request-requested-reviewer", "revision": "text", "requestedBy": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } }, "createdAt": "2025-08-26T23:19:07.272Z", "kind": "user", "user": { "object": "user", "id": "text", "displayName": "text", "email": "text", "photoURL": "text", "urls": { "location": "https://example.com" } } } ] }