*REST API › Objects › Platform*

# Note

> Note attached to an entity of the account.

A note attached to an entity of the account. A note is always read for one entity: [`GET /api/v1/notes`](https://docs.filmo.io/rest-api/endpoint-reference/notes/list-the-notes-of-an-entity) requires the type and the identifier of the entity, and there is no list of all notes. Who wrote the note is not published.

Schemas: `NoteDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `id` | string | Unique identifier of the note. |
| `content` | string | Note text. |
| `relatedDocumentType` | string | Type of the entity the note is attached to; null if it is not attached. |
| `relatedDocumentId` | string | Identifier of that entity; null if the note is not attached. |
| `subRelatedDocumentType` | string | Type of the sub-entity; null if not applicable. |
| `subRelatedDocumentId` | string | Identifier of the sub-entity; null if not applicable. |
| `subRelatedDocumentCode` | string | Human-readable code of the sub-entity; null if not applicable. |
| `createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |

## Example

*Note · Generated from the schema*

```json
{
  "id": "id_8f2a1c",
  "content": "string",
  "relatedDocumentType": "string",
  "relatedDocumentId": "string",
  "subRelatedDocumentType": "string",
  "subRelatedDocumentId": "string",
  "subRelatedDocumentCode": "string",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/notes`](https://docs.filmo.io/rest-api/endpoint-reference/notes/list-the-notes-of-an-entity) — List the notes of an entity

## Modified by

- [`POST /api/v1/notes`](https://docs.filmo.io/rest-api/endpoint-reference/notes/write-a-note-on-an-entity) — Write a note on an entity

---

Canonical URL: https://docs.filmo.io/rest-api/objects/note  
Last updated: 2026-10-25