Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function fetchNotes() {
  const response = await client.reaction.getNoteById({
    note_id: 'true_xxxxxxxxx-9892-40e9-af89-be65916ac089_bharat@hashlabs.dev'
  });

  console.log(response);
}
etchNotes();
{
  "message_id": "true_2dc1aa2c-d711-4497-864d-92bb5709xxxx_api",
  "org_id": "2997dd64-89bf-48d3-9a22-b314fca0xxxx",
  "ack": "3",
  "body": "testing with a new note payload",
  "from_me": true,
  "message_type": "audio",
  "chat_id": "91882424xxxx@c.us",
  "timestamp": "2025-08-20T10:58:27.642+00:00",
  "org_phone": "91852718xxxx@c.us",
  "performed_by": "api",
  "prev_body": null,
  "quoted_message_id": null,
  "sender_phone": "91852718xxxx@c.us",
  "sent_message_id": "2dc1aa2c-d711-4497-864d-92bb57092073",
  "updated_at": "2025-08-20T10:58:27.642+00:00",
  "is_private_note": true,
  "media": {
    "path": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us%2F2dc1aa2c-d711-4497-864d-92bb57092073%2Fbeep.wav",
    "filename": "beep.wav",
    "mimetype": "audio/wav"
  },
  "unique_id": "2dc1aa2c-d711-4497-864d-92bb57092073",
  "mentioned_ids": [],
  "is_deleted": null
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Path Parameters

note_id
string
required
  • The note_id of the private note
Example:

"true_91953785XXXX@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C"

Response

200 - application/json

Note

The response is a note object. Refer to the note object here