v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB

Notes

Retrieve a note

You can fetch the details of a single note.

get/notes/{note_id}

Path parameters

note_idinteger required

The unique identifier of a given note

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Note found

typestring

String representing the object's type. Always has the value note.

idstring

The id of the note.

created_atinteger

The time the note was created.

bodystring

The body text of the note.

Example response

{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "contact": {
    "id": "214656d0c743eafcfde7f248"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Joe Example",
    "email": "jdoe@example.com",
    "job_title": "Associate",
    "away_status_reason_id": 12345,
    "has_inbox_seat": true,
    "team_ids": [
      814865
    ],
    "avatar": "https://picsum.photos/200/300",
    "team_priority_level": {
      "primary_team_ids": [
        814865
      ],
      "secondary_team_ids": [
        493881
      ]
    }
  },
  "body": "<p>Text for the note.</p>"
}