---
title: "A release's notes, or (generate=1) notes written from the merges since the last published release"
description: "With `generate`, for a release, a tag, or a release still to be made (`target`, else main)."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Pando API › releases

`GET /v1/monorepos/{owner}/{monorepo}/repos/{repo}/releases/{tag}/notes`

With `generate`, for a release, a tag, or a release still to be made (`target`, else main).

## Authentication

Requires one of the following:

- `credential`, http, header `Authorization`
- `session`, apiKey, in cookie

## Path parameters

- `getReleaseNotes.path.owner` (string, required) — The monorepo's owner, a namespace (a person's login or an organization). Matched without case.
  - pattern `^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$`
- `getReleaseNotes.path.monorepo` (string, required) — The monorepo's name within its owner (or an old name). Matched without case.
  - pattern `^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$`
- `getReleaseNotes.path.repo` (string, required) — The repo's `name` (`projects-web`).
- `getReleaseNotes.path.tag` (string, required)

## Query parameters

- `getReleaseNotes.query.generate` (string, optional)
  - one of `"1"`
- `getReleaseNotes.query.target` (string, optional)

## Code samples

### cURL

```curl
curl --request GET \
  --url https://app.gitpando.com/v1/monorepos/string/string/repos/string/releases/string/notes \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://app.gitpando.com/v1/monorepos/string/string/repos/string/releases/string/notes';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://app.gitpando.com/v1/monorepos/string/string/repos/string/releases/string/notes"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

OK

#### Example

```json
{
  "tag": "string",
  "sha": "string",
  "markdown": "string",
  "generated": true,
  "merges": 0,
  "more": 0,
  "since": "string"
}
```

- `getReleaseNotes.response.200.tag` (string, required)
- `getReleaseNotes.response.200.sha` (string, required)
- `getReleaseNotes.response.200.markdown` (string, required)
- `getReleaseNotes.response.200.generated` (boolean, required)
- `getReleaseNotes.response.200.merges` (integer | null, required) — Generated: the merges listed (at most 500).
- `getReleaseNotes.response.200.more` (integer | null, required) — Generated: the merges past 500.
- `getReleaseNotes.response.200.since` (string | null, required) — Generated: the release they start from; null from the start.


Source: https://docs.gitpando.com/api/releases/getReleaseNotes/index.md
