List all company notes

Request

You can fetch a list of notes that are associated to a company.

Security

bearerAuth

Path

company_idstringrequired

The unique identifier for the company which is given by Intercom

Example:5f4d3c1c-7b1b-4d7d-a97e-6095715c6632

Intercom-Versionstring(intercom_version)

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

Default:"2.16"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.16

require 'uri'
require 'net/http'
require 'openssl'

company_id = '5f4d3c1c-7b1b-4d7d-a97e-6095715c6632'
url = URI('https://api.intercom.io/companies/' + company_id + '/notes')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request['Intercom-Version'] = '2.16'
request['Authorization'] = 'Bearer <YOUR_TOKEN_HERE>'

response = http.request(request)
puts response.read_body

Responses

Successful response

Bodyapplication/json

typestring

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

Example:"list"

dataArray of objects(Note)

An array of notes.

total_countinteger

A count of the total number of notes.

Example:1

pagesobject or null(Cursor based pages)

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

Response

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "next": null,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}