HighLevel: Get Note

← Contacts operations · Get started

Operation gohighlevel.get_note

Provider route: GET /contacts/{contactId}/notes/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["contacts"]["getNote"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.contacts.getNote(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.contacts.get_note(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.contactId	string	Required within parent
path.id	string	Required within parent

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Note — response body

Referenced models: Get Note — response body

Schemas

Get Note — response body

Field	Type	Presence	Description and constraints
$	object	Root
note	JSON	Optional	Note details
note (allOf 1)	Model	All variants apply	Expand Get All Notes — response body — notes item

Referenced models: Get All Notes — response body — notes item

Get All Notes — response body — notes item

Field	Type	Presence	Description and constraints
$	object	Root
body	string	Optional	Body content of the note
color	string	Optional	Hex color code for the note
contactId	string	Optional	Contact Id associated with the note
dateAdded	string	Optional	Date the note was added (ISO 8601 format)
id	string	Optional	Unique identifier of the note
pinned	boolean	Optional	Whether the note is pinned
title	string	Optional	Title of the note
userId	string	Optional	User Id of the note author

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_note. Catalog operation: get-note. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["contacts.readonly"]

Pinned headers: {"Version": "v3"}

Official provider source