Notes

Everything about your Notes

Operations

MethodEndpointDescription
GET/companies/{company_id}/notesList all company notes
POST/companies/{company_id}/notesCreate a company note
GET/contacts/{contact_id}/notesList all notes
POST/contacts/{contact_id}/notesCreate a note
GET/notes/{note_id}Retrieve a note
DELETE/notes/{note_id}Delete a note

Example

List all company notes, with the TypeScript SDK:

ts
import { Intercom } from "@octridev/intercom";

const client = new Intercom({
  // Optional: replaces the default server and any server an operation declares.
  baseUrl: "https://api.intercom.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.notes.list({
  companyId: "company-1",
});
console.log(result);
Nine more languages

The same call exists in every SDK. See SDKs for the other nine.