DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

View a Note

Example Request

$ curl https://api.intercom.io/notes/2 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK

{
  "type": "note",
  "id": "2",
  "created_at": 1389913951,
  "body": "<p>Text for my note</p>",
  "user": {
      "id": "5310d8e8598c9a0b24000005",
      "type": "user"
    },
  "author": {
    "type": "admin",
    "id": "21",
    "name": "Jayne Cobb",
    "email": "[email protected]",
    "avatar" : {
       "type":"avatar",
      "image_url": "http://example.org/128Jayne.jpg"
    },
    "companies": []
  }
}
intercom.notes.find(:id => note)
<?php
$note = $intercom->notes->getNote("9259097");
?>
Note note = Note.find("2");

Each note has its own URL -

  • https://api.intercom.io/notes/{id}

Where {id} is the value of the note's id field. A GET request to a note's URL will return the note object.

Returns

A note object.