@@ -3196,6 +3196,109 @@ paths:
3196
3196
message: Access Token Invalid
3197
3197
schema:
3198
3198
"$ref": "#/components/schemas/error"
3199
+ "/companies/{id}/notes":
3200
+ get:
3201
+ summary: List all notes
3202
+ parameters:
3203
+ - name: id
3204
+ in: path
3205
+ required: true
3206
+ description: The unique identifier for the company which is given by Intercom
3207
+ example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3208
+ schema:
3209
+ type: string
3210
+ - name: Intercom-Version
3211
+ in: header
3212
+ schema:
3213
+ "$ref": "#/components/schemas/intercom_version"
3214
+ tags:
3215
+ - Notes
3216
+ - Companies
3217
+ operationId: listCompanyNotes
3218
+ description: You can fetch a list of notes that are associated to a company.
3219
+ responses:
3220
+ '200':
3221
+ description: Successful response
3222
+ content:
3223
+ application/json:
3224
+ examples:
3225
+ Successful response:
3226
+ value:
3227
+ type: list
3228
+ data:
3229
+ - type: note
3230
+ id: '26'
3231
+ created_at: 1733932587
3232
+ company:
3233
+ type: company
3234
+ id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3235
+ author:
3236
+ type: admin
3237
+ id: '991267581'
3238
+ name: Ciaran122 Lee
3239
+
3240
+ away_mode_enabled: false
3241
+ away_mode_reassign: false
3242
+ away_status_reason_id: null
3243
+ has_inbox_seat: true
3244
+ team_ids: []
3245
+ team_priority_level: {}
3246
+ body: "<p>This is a note.</p>"
3247
+ - type: note
3248
+ id: '25'
3249
+ created_at: 1733846187
3250
+ company:
3251
+ type: company
3252
+ id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3253
+ author:
3254
+ type: admin
3255
+ id: '991267581'
3256
+ name: Ciaran122 Lee
3257
+
3258
+ away_mode_enabled: false
3259
+ away_mode_reassign: false
3260
+ body: "<p>This is a note.</p>"
3261
+ - type: note
3262
+ id: '24'
3263
+ created_at: 1733846187
3264
+ company:
3265
+ type: company
3266
+ id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3267
+ author:
3268
+ type: admin
3269
+ id: '991267581'
3270
+ name: Ciaran122 Lee
3271
+
3272
+ away_mode_enabled: false
3273
+ away_mode_reassign: false
3274
+ away_status_reason_id: null
3275
+ has_inbox_seat: true
3276
+ team_ids: []
3277
+ team_priority_level: {}
3278
+ body: "<p>This is a note.</p>"
3279
+ total_count: 3
3280
+ pages:
3281
+ type: pages
3282
+ next:
3283
+ page: 1
3284
+ per_page: 50
3285
+ total_pages: 1
3286
+ schema:
3287
+ "$ref": "#/components/schemas/company_note_list"
3288
+ '404':
3289
+ description: Company not found
3290
+ content:
3291
+ application/json:
3292
+ examples:
3293
+ Company not found:
3294
+ value:
3295
+ type: error.list
3296
+ request_id: 57055cde-3d0d-4c67-b5c9-b20b80340bf0
3297
+ errors:
3298
+ - code: company_not_found
3299
+ message: Company Not Found
3300
+ schema:
3301
+ "$ref": "#/components/schemas/error"
3199
3302
"/companies/list":
3200
3303
post:
3201
3304
summary: List all companies
@@ -21102,6 +21205,69 @@ components:
21102
21205
example: 1
21103
21206
pages:
21104
21207
"$ref": "#/components/schemas/cursor_pages"
21208
+ company_note_list:
21209
+ title: Paginated Company Notes Response
21210
+ type: object
21211
+ description: A paginated list of notes associated with a company.
21212
+ properties:
21213
+ type:
21214
+ type: string
21215
+ description: String representing the object's type. Always has the value
21216
+ `list`.
21217
+ example: list
21218
+ data:
21219
+ type: array
21220
+ description: An array of company notes.
21221
+ items:
21222
+ "$ref": "#/components/schemas/company_note"
21223
+ total_count:
21224
+ type: integer
21225
+ description: A count of the total number of notes.
21226
+ example: 1
21227
+ pages:
21228
+ "$ref": "#/components/schemas/cursor_pages"
21229
+ company_note:
21230
+ title: Company Note
21231
+ type: object
21232
+ x-tags:
21233
+ - Notes
21234
+ description: Notes allow you to annotate and comment on companies.
21235
+ properties:
21236
+ type:
21237
+ type: string
21238
+ description: String representing the object's type. Always has the value
21239
+ `note`.
21240
+ example: note
21241
+ id:
21242
+ type: string
21243
+ description: The id of the note.
21244
+ example: '17495962'
21245
+ created_at:
21246
+ type: integer
21247
+ format: timestamp
21248
+ description: The time the note was created.
21249
+ example: 1674589321
21250
+ company:
21251
+ type: object
21252
+ description: Represents the company that the note was created about.
21253
+ nullable: true
21254
+ properties:
21255
+ type:
21256
+ type: string
21257
+ description: String representing the object's type. Always has the value
21258
+ `company`.
21259
+ example: company
21260
+ id:
21261
+ type: string
21262
+ description: The id of the company.
21263
+ example: 6329bd9ffe4e2e91dac76188
21264
+ author:
21265
+ "$ref": "#/components/schemas/admin"
21266
+ description: Optional. Represents the Admin that created the note.
21267
+ body:
21268
+ type: string
21269
+ description: The body text of the note.
21270
+ example: "<p>Text for the note.</p>"
21105
21271
open_conversation_request:
21106
21272
title: Open Conversation Request
21107
21273
type: object
0 commit comments