v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
note

Get Private Note

This endpoint retrieves a specific private note based on a specific note_id.

get/notes/{note_id}

Path parameters

note_idstring required
Example:true_91953785XXXX@c.us_3EB0C62861626B2D8BD4A386E48976EC85CB009C
  • The note_id of the private note

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, the note is looked up for that phone. When omitted, the note is looked up 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); note_id is effectively unique, so a single note is returned. Passing a phone that is outside your token's scope returns a 401.

Response

Note

object required

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