> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# List notes for students in a family

GET https://ssuccessv2.com/app/api/v1/family/{id}/notes

Returns notes belonging to students in the family. Use batch_id to restrict notes to one academic year.

Reference: https://docs.schoolset.io/api-reference/school-set-api/families/get-family-notes

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `id` (integer, required)

### Query parameters

- `batch_id` (integer, optional)

## Response

### 200

Notes returned.

- `status` (string, optional)
- `message` (string, optional)
- `data` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItems, optional)

## Errors

### 401 Unauthorized Error

Authentication required.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

The user lacks note view permission.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

Family not found.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

## Types

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItems

- `id` (integer, required)
- `title` (string, required)
- `note` (string, required)
- `draft` (boolean, required)
- `favorite` (boolean, required)
- `students` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsStudentsItems, required)
- `academic_year` (map from string to any, optional)
- `type` (map from string to any, optional)
- `status` (map from string to any, optional)
- `created_by` (string, optional, nullable)
- `attachments` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsAttachmentsItems, optional)
- `categories` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems, optional)
- `school_grades` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsSchoolGradesItems, optional)
- `school_classes` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsSchoolClassesItems, optional)
- `folders` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsFoldersItems, optional)
- `contributors` (list of ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsContributorsItems, optional)
- `created_at` (datetime, optional, nullable)
- `updated_at` (datetime, optional, nullable)

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsStudentsItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsAttachmentsItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsSchoolGradesItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsSchoolClassesItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsFoldersItems

### ApiV1FamilyIdNotesGetResponsesContentApplicationJsonSchemaDataItemsContributorsItems

## Examples

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 610,
      "title": "Asthma action plan",
      "note": "Updated inhaler instructions received.",
      "draft": false,
      "favorite": true,
      "students": [
        {
          "id": 2987,
          "firstname": "Mateo",
          "lastname": "Garcia"
        }
      ],
      "academic_year": {
        "id": 2026,
        "name": "2026-2027"
      },
      "type": {
        "title": "Medical"
      },
      "status": {
        "title": "Active"
      },
      "created_by": "Office Admin",
      "attachments": [],
      "categories": [],
      "school_grades": [],
      "school_classes": [],
      "folders": [],
      "contributors": [],
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  ]
}
```

**SDK Code**

```python Families_getFamilyNotes_example
import requests

url = "https://ssuccessv2.com/app/api/v1/family/1842/notes"

querystring = {"batch_id":"2026"}

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

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

print(response.json())
```

```javascript Families_getFamilyNotes_example
const url = 'https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Families_getFamilyNotes_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Families_getFamilyNotes_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Families_getFamilyNotes_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Families_getFamilyNotes_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Families_getFamilyNotes_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Families_getFamilyNotes_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/family/1842/notes?batch_id=2026")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```