v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
note

Fetch Private Notes

This endpoint retrieves a paginated list of all private notes across chats (in descending order of timestamp).

Response

The response is an array of JSON note objects. Refer to the note object here

get/notes

Query parameters

offsetnumber
  • The offset value for paginating the results
  • Default 0
limitnumber
  • The maximum number of notes to retrieve
  • Default 500
start_timestring
  • Filter for all notes from the start_time timestamp onwards
Example:2025-04-25 or 2025-04-25T00:00:00Z
end_timestring
  • Filter for all notes up to the end_time timestamp
Example:2025-04-31 or 2025-04-31T23:59:59Z

Headers

x-phonestring
Example:{{orgPhone}}

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 private notes for that phone are returned. When omitted, notes 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

fromnumber

The starting index of the notes returned

tonumber

The ending index of the notes returned

start_timestring

The start_time of the notes returned. The format should be YYYY-MM-DDTHH:MM:SSZ

end_timestring

The end_time of the notes returned. The format should be YYYY-MM-DDTHH:MM:SSZ

countnumber

The total number of notes returned

Example response

{
  "from": 1,
  "to": 10,
  "start_time": "2025-08-15T00:00:00Z",
  "end_time": "2025-08-15T23:59:59Z",
  "count": 10
}