---
title: "Whether Hostingsurge comments on the project's GitHub pull requests with the branch preview (default on)"
method: GET
path: "/projects/{projectId}/pull-request-comments"
tags: ["GitHub"]
---

# Whether Hostingsurge comments on the project's GitHub pull requests with the branch preview (default on)

`GET /projects/{projectId}/pull-request-comments`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/projects/{projectId}/pull-request-comments`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `projectId` string, uuid, required

## Response `200`

The setting

- object
  - `projectId` string, uuid, required
  - `enabled` boolean, required: the project switch (default on): comment on pull requests with the branch preview
  - `configured` boolean, required: this server can write to GitHub (the customer GitHub App's private key is installed); false: nothing is posted whatever the switch says
  - `eligible` boolean, required: the project deploys a GitHub repository (only those get pull request comments)
  - `appConnected` boolean, required: the repository is connected through the Hostingsurge GitHub App, whose installation writes the comment; false: comments are written only when the organization's Hostingsurge GitHub App installation also covers the repository (a push-webhook project)
  - `updatedAt` string, nullable, required: ISO-8601; null while the project still has the default

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `501`: The feature's database migration is not applied on this server yet (code not_configured)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
