DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

List Notes for a User

Example User ID Request

$ curl https://api.intercom.io/notes?user_id=25 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
intercom.notes.find_all(:user_id => '123').each {|note| puts note.body}
<?php
$notes = $intercom->notes->getNotes(["user_id" => "20413"]);
foreach ($notes->notes as $note) {
    print "id:".$note->id." body:".$note->body."\n";
}
?>
Map<String, String> params = Maps.newHashMap();
params.put("user_id", "123");
NoteCollection notes = Note.list(params);
while (notes.hasNext()) {
    out.println(notes.next().getBody());
}
Example Email Request

$ curl https://api.intercom.io/notes?email=jayne%40serenity.io \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
HTTP/1.1 200 OK

{
  "type": "note.list",
  "notes": [
    {
      "type": "note",
      "id": "1",
      "created_at": 1389913941,
      "body": "<p>Text for my note</p>",
      "author": {
        "type": "admin",
        "id": "21",
        "name": "Jayne Cobb",
        "email": "[email protected]",
        "companies": []
      },
      "user": {
        "type": "user",
        "id": "5310d8e8598c9a0b24000005"
      }
    },
    {
      "type": "note",
      "id": "2",
      "created_at": 1389913951,
      "body": "<p>Text for my note</p>",
      "user": {
          "id": "5310d8e8598c9a0b24000005",
          "type": "user"
        }
    }
  ],
  "pages": {}
}
intercom.notes.find_all(:email => '[email protected]').each {|note| puts note.body}
<?php
$notes = $intercom->notes->getNotes(["email" => "[email protected]"]);

foreach ($notes->notes as $note) {
    print "id:".$note->id." body:".$note->body."\n";
}
?>
Map<String, String> params = Maps.newHashMap();
params.put("email", "[email protected]");
notes = Note.list(params);
while (notes.hasNext()) {
    out.println(notes.next().getBody());
}
Example ID Request

$ curl \
https://api.intercom.io/notes?id=5310d8e8598c9a0b24000005 \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept: application/json'
# Not exposed in Ruby client
<?php
$notes = $intercom->notes->getNotes(["id" => "5965efd9aad5c02fc4750ee6"]);
foreach ($notes->notes as $note) {
    print "id:".$note->id." body:".$note->body."\n";
}
?>
Map<String, String> params = Maps.newHashMap();
params.put("id", "5310d8e8598c9a0b24000005");
notes = Note.list(params);
while (notes.hasNext()) {
    out.println(notes.next().getBody());
}

A user's notes can be fetched by using a GET request to https://api.intercom.io/notes with an Intercom user id or user_id or email query parameter.

The value of the email parameter should be url encoded before sending.

Parameters

Parameter

Required

Description

user_id

one of

The user id you have defined for the user

email

one of

The email you have defined for the user

id

one of

The Intercom defined id representing the user

Returns

A list of note objects for that User.

Note List Object

Attribute

Type

Description

type

string

value is 'note.list'

notes

array

A list of note objects