docs

descriptions/0/api.intercom.io.yaml

@@ -2677,6 +2677,12 @@ paths:
                     segments:
                       type: segment.list
                       segments: []
+                    notes:
+                      type: note.list
+                      data: []
+                      url: "/companies/6762f0761bb69f9f2193bae2/notes"
+                      total_count: 0
+                      has_more: false
                     plan: {}
                     custom_attributes:
                       creation_source: api
@@ -2817,6 +2823,12 @@ paths:
                       segments:
                         type: segment.list
                         segments: []
+                      notes:
+                        type: note.list
+                        data: []
+                        url: "/companies/6762f07a1bb69f9f2193baea/notes"
+                        total_count: 0
+                        has_more: false
                       plan: {}
                       custom_attributes: {}
                     pages:
@@ -2900,6 +2912,12 @@ paths:
                     segments:
                       type: segment.list
                       segments: []
+                    notes:
+                      type: note.list
+                      data: []
+                      url: "/companies/6762f0761bb69f9f2193bae2/notes"
+                      total_count: 0
+                      has_more: false
                     plan: {}
                     custom_attributes: {}
               schema:
@@ -2980,6 +2998,12 @@ paths:
                     segments:
                       type: segment.list
                       segments: []
+                    notes:
+                      type: note.list
+                      data: []
+                      url: "/companies/6762f0841bb69f9f2193baff/notes"
+                      total_count: 0
+                      has_more: false
                     plan: {}
                     custom_attributes: {}
               schema:
@@ -3266,6 +3290,12 @@ paths:
                       segments:
                         type: segment.list
                         segments: []
+                      notes:
+                        type: note.list
+                        data: []
+                        url: "/companies/6762f0941bb69f9f2193bb25/notes"
+                        total_count: 0
+                        has_more: false
                       plan: {}
                       custom_attributes: {}
                     pages:
@@ -3351,6 +3381,12 @@ paths:
                       segments:
                         type: segment.list
                         segments: []
+                      notes:
+                        type: note.list
+                        data: []
+                        url: "/companies/6762f0971bb69f9f2193bb2b/notes"
+                        total_count: 0
+                        has_more: false
                       plan: {}
                       custom_attributes: {}
                     pages:
@@ -3416,6 +3452,12 @@ paths:
                     segments:
                       type: segment.list
                       segments: []
+                    notes:
+                      type: note.list
+                      data: []
+                      url: "/companies/6762f09a1bb69f9f2193bb34/notes"
+                      total_count: 0
+                      has_more: false
                     plan: {}
                     custom_attributes: {}
               schema:
@@ -16475,6 +16517,19 @@ components:
               type: array
               items:
                 "$ref": "#/components/schemas/segment"
+        notes:
+          type: object
+          description: The list of notes associated with the company
+          properties:
+            type:
+              type: string
+              description: The type of the object
+              enum:
+              - note.list
+            notes:
+              type: array
+              items:
+                "$ref": "#/components/schemas/company_note"
     company_attached_contacts:
       title: Company Attached Contacts
       type: object
@@ -21102,6 +21157,48 @@ components:
           example: 1
         pages:
           "$ref": "#/components/schemas/cursor_pages"
+    company_note:
+      title: Company Note
+      type: object
+      x-tags:
+      - Notes
+      description: Notes allow you to annotate and comment on companies.
+      properties:
+        type:
+          type: string
+          description: String representing the object's type. Always has the value
+            `note`.
+          example: note
+        id:
+          type: string
+          description: The id of the note.
+          example: '17495962'
+        created_at:
+          type: integer
+          format: timestamp
+          description: The time the note was created.
+          example: 1674589321
+        company:
+          type: object
+          description: Represents the company that the note was created about.
+          nullable: true
+          properties:
+            type:
+              type: string
+              description: String representing the object's type. Always has the value
+                `company`.
+              example: company
+            id:
+              type: string
+              description: The id of the company.
+              example: 6329bd9ffe4e2e91dac76188
+        author:
+          "$ref": "#/components/schemas/admin"
+          description: Optional. Represents the Admin that created the note.
+        body:
+          type: string
+          description: The body text of the note.
+          example: "<p>Text for the note.</p>"
     open_conversation_request:
       title: Open Conversation Request
       type: object