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

# The Note Object

> A private note attached to a chat. Notes are internal to the workspace — they are never sent to WhatsApp and contacts cannot see them. Notes share the message record shape, so responses may include additional message fields (ack, sender_phone, sent_message_id, unique_id).

```json The Note Object theme={null}
{
  "message_id": "true_00000000-0000-0000-0000-000000000000_api",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "org_phone": "911111111111@c.us",
  "chat_id": "120363000000000000@g.us",
  "body": "Customer asked for a callback tomorrow @user@example.com",
  "message_type": "chat",
  "media": {
    "path": "https://example.com/files/image.png",
    "mimetype": "image/png",
    "filename": "image.png"
  },
  "is_private_note": true,
  "from_me": true,
  "performed_by": "api",
  "quoted_message_id": "true_00000000-0000-0000-0000-000000000000_api",
  "mentioned_ids": [
    "user@example.com"
  ],
  "timestamp": "2026-01-15T09:30:00.000Z",
  "updated_at": "2026-01-15T09:30:00.000Z"
}
```

**Attributes**

**message\_id** `string`

Unique id of the note, in the form true\_\<uuid>\_\<performed\_by>. Use this value as the note\_id path parameter when fetching a single note.

**org\_id** `string`

Id of the organization the note belongs to

**org\_phone** `string`

Org phone (WhatsApp account) the note was created under, as country code + number suffixed with @c.us

**chat\_id** `string`

Chat the note is attached to — \<countrycode>\<number>@c.us for 1-1 chats, \<group-id>@g.us for group chats

**body** `string`

Text content of the note. null for media-only notes.

**message\_type** `string`

Content type of the note: 'chat' for text-only notes, otherwise the attachment type ('image', 'video', 'document' or 'audio')

**media** `object`

Attachment details. null for text-only notes.

**properties**

**path** `string`

URL of the attachment — the url provided at creation, or the storage URL of the uploaded filedata

**mimetype** `string`

MIME type of the attachment

**filename** `string`

Filename of the attachment — the filename provided at creation, or one derived from the url

**is\_private\_note** `string`

Always true — marks the record as a private note rather than a WhatsApp message One of: `true`.

**from\_me** `boolean`

Always true for notes — notes are authored by the org, never by the contact

**performed\_by** `string`

Who created the note: the member's email, or "api" when created via the API

**quoted\_message\_id** `string`

message\_id of the message or note this note replies to (set via reply\_to at creation). null when the note is not a reply.

**mentioned\_ids** `string[]`

Member emails @-mentioned in the note body. Each mention creates a task assigned to that member.

**timestamp** `string`

When the note was created, as an ISO 8601 UTC timestamp

**updated\_at** `string`

When the note was last updated, as an ISO 8601 UTC timestamp


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.