Get Private Notes in a Chat
This endpoint retrieves a paginated list of all private notes from a specific chat (in descending order of timestamp).
Response
The response is an array of JSON note objects. Refer to the note object here
Request
- Base URLhttps://api.periskope.app/v1
- URLhttps://api.periskope.app/v1/chats/{chat_id}/notes
- AuthHTTP bearer
Path parameters
- The unique id of a chat
- For groups, enter the chat_id of the group. This will be a string that ends with @g.us
- For 1-1 chats, enter the country_code + number of the recipient e.g. 919537851844@c.us (The @c.us is optional)
Query parameters
- The offset value for paginating the results
- Default 0
- The maximum number of notes to retrieve
- Default 500
- Filter for all notes from the start_time timestamp onwards
- Filter for all notes up to the end_time timestamp
Headers
Optional. The phone to scope this request to — in country code + number format with no spaces or special characters (e.g. 919876543210), or the phone_id (phone-xxxxxxxxxxxx). When set, only notes in this chat for that phone are returned. When omitted, notes in this chat are returned — across all phones your token can access (the phones in your token's scope, or every phone in your organization if the token is unscoped). Passing a phone that is outside your token's scope returns a 401.
Response
Note
Example response
{
"from": 1,
"to": 10,
"start_time": "2025-08-15T00:00:00Z",
"end_time": "2025-08-15T23:59:59Z",
"count": 10
}Changes
No recorded changes to this operation across all 2 revisions of this API.