---
title: "Retrieve location notes"
method: GET
path: "/locations/{locationId}/notes"
tags: ["Locations"]
---

# Retrieve location notes

`GET /locations/{locationId}/notes`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/locations/{locationId}/notes`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/locations/:locationId/notes/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the location notes for the specified location.

## Path parameters

- `locationId` integer, required

## Query parameters

- `privateNotes` boolean

## Response `200`

Location notes are in the response.

- ServiceChannelServicesMessagingLocationNoteLocationNote: Object with the location note details.
  - `Id` integer: Location note numeric identifier.
  - `HeaderId` integer: Unique location note header identifier.
  - `Value` string: Location note content.
  - `Header` string: Name of the note.

## Other responses

- `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc. <br/>Error codes: 601 — Location not found
- `401`: The request is not authorized. <br/>Error codes: 504 - API call rejected by security permissions
- `500`: The server was unable to complete the request due to an internal error.

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)