---
title: "Return a list of notes for a given scenario"
method: GET
path: "/macro_notes"
tags: ["scenarios"]
---

# Return a list of notes for a given scenario

`GET /macro_notes`

## Query parameters

- `scenario_id` integer, required
- `page` integer
- `page_size` integer

## Response `200`

List of macro notes for the requested scenario

- MacroNoteListResponse — Statistics about a paginated editoast response Provides the pagination settings issued in the request alongside a few convenience fields useful to navigate the paginated results. # Expected usage This struct is meant to be used and flattened in the response of a paginated query. ``` #[derive(Serialize, ToSchema)] struct MyPaginatedResponse { #[schema(flatten)] pagination: PaginationStats, result: Vec<MyData>, // any other field that makes sense in a paginated response } ``` We named the data field `result` to cope with the old pagination schema which enforced this name. For new paginated responses, the field name is up to your imagination :)
  - `count` integer, required — The total number of items
  - `current` integer, required — The current page number
  - `next` integer, nullable, required — The next page number, if any
  - `page_count` integer, required — The total number of pages
  - `page_size` integer, required — The number of items per page
  - `previous` integer, nullable, required — The previous page number, if any
  - `results` MacroNoteResponse[], required
    - `id` integer, required
    - `labels` string[], required
    - `text` string, required
    - `title` string, required
    - `x` integer, required
    - `y` integer, required

---

[API](https://skmtc.net/openrailassociation/apis/osrd-editoast.md) · [All operations](https://skmtc.net/openrailassociation/apis/osrd-editoast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openrailassociation/osrd-editoast/versions/1840dbbd64ac/schema)