List Company Notes

List all company notes

GET/companies/{company_id}/notes

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the List Company Notes action (under Notes).
Fill in the fields below, then reference the result from later steps as {{listCompanyNotes.response.data}}.

Request

Path parameters

company_idstringrequired

The unique identifier for the company which is given by Intercom

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Response

Returns 200 with an object. Read it in later steps with {{listCompanyNotes.response.data.<field>}}.

typestring

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

dataarray<object>

An array of notes.

typestring

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

idstring

The id of the note.

created_atinteger (timestamp)

The time the note was created.

contactobject2 fields

Represents the contact that the note was created about.

companyobject2 fields

Represents the company that the note was created about.

authorobject13 fields

Admins are teammate accounts that have access to a workspace.

bodystring

The body text of the note.

total_countinteger

A count of the total number of notes.

pagesobject

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.

typestring

the type of object `pages`.

One ofpages

pageinteger

The current page

nextobject2 fields

per_pageinteger

Number of results per page

total_pagesinteger

Total number of pages

json

{
  "type": "list",
  "data": [
    {
      "type": "note",
      "id": "17495962",
      "created_at": 1674589321,
      "contact": {
        "type": "string",
        "id": "214656d0c743eafcfde7f248"
      },
      "company": {
        "type": "string",
        "id": "5f4d3c1c-7b1b-4d7d-a97e-6095715c6632"
      },
      "author": {
        "type": "admin",
        "id": "1295",
        "name": "Joe Example",
        "email": "jdoe@example.com",
        "job_title": "Associate",
        "away_mode_enabled": false,
        "away_mode_reassign": false,
        "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>"
    }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": {
      "per_page": 2,
      "starting_after": "your-cursor-from-response"
    },
    "per_page": 2,
    "total_pages": 13
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?