Skip to content

Commit 45aaa1d

Browse files
markdennis22claude
andcommitted
Add GET /companies/{id}/notes endpoint
Added new endpoint to list all notes associated with a company. This follows the same pattern as the existing /contacts/{id}/notes endpoint. - Added endpoint definition at /companies/{id}/notes - Created company_note_list schema for paginated response - Included proper error handling for company not found 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent bfb5845 commit 45aaa1d

File tree

1 file changed

+124
-0
lines changed

1 file changed

+124
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3220,6 +3220,109 @@ paths:
32203220
message: Access Token Invalid
32213221
schema:
32223222
"$ref": "#/components/schemas/error"
3223+
"/companies/{id}/notes":
3224+
get:
3225+
summary: List all notes
3226+
parameters:
3227+
- name: id
3228+
in: path
3229+
required: true
3230+
description: The unique identifier for the company which is given by Intercom
3231+
example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3232+
schema:
3233+
type: string
3234+
- name: Intercom-Version
3235+
in: header
3236+
schema:
3237+
"$ref": "#/components/schemas/intercom_version"
3238+
tags:
3239+
- Notes
3240+
- Companies
3241+
operationId: listCompanyNotes
3242+
description: You can fetch a list of notes that are associated to a company.
3243+
responses:
3244+
'200':
3245+
description: Successful response
3246+
content:
3247+
application/json:
3248+
examples:
3249+
Successful response:
3250+
value:
3251+
type: list
3252+
data:
3253+
- type: note
3254+
id: '26'
3255+
created_at: 1733932587
3256+
company:
3257+
type: company
3258+
id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3259+
author:
3260+
type: admin
3261+
id: '991267581'
3262+
name: Ciaran122 Lee
3263+
3264+
away_mode_enabled: false
3265+
away_mode_reassign: false
3266+
away_status_reason_id: null
3267+
has_inbox_seat: true
3268+
team_ids: []
3269+
team_priority_level: {}
3270+
body: "<p>This is a note.</p>"
3271+
- type: note
3272+
id: '25'
3273+
created_at: 1733846187
3274+
company:
3275+
type: company
3276+
id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3277+
author:
3278+
type: admin
3279+
id: '991267581'
3280+
name: Ciaran122 Lee
3281+
3282+
away_mode_enabled: false
3283+
away_mode_reassign: false
3284+
body: "<p>This is a note.</p>"
3285+
- type: note
3286+
id: '24'
3287+
created_at: 1733846187
3288+
company:
3289+
type: company
3290+
id: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
3291+
author:
3292+
type: admin
3293+
id: '991267581'
3294+
name: Ciaran122 Lee
3295+
3296+
away_mode_enabled: false
3297+
away_mode_reassign: false
3298+
away_status_reason_id: null
3299+
has_inbox_seat: true
3300+
team_ids: []
3301+
team_priority_level: {}
3302+
body: "<p>This is a note.</p>"
3303+
total_count: 3
3304+
pages:
3305+
type: pages
3306+
next:
3307+
page: 1
3308+
per_page: 50
3309+
total_pages: 1
3310+
schema:
3311+
"$ref": "#/components/schemas/company_note_list"
3312+
'404':
3313+
description: Company not found
3314+
content:
3315+
application/json:
3316+
examples:
3317+
Company not found:
3318+
value:
3319+
type: error.list
3320+
request_id: 57055cde-3d0d-4c67-b5c9-b20b80340bf0
3321+
errors:
3322+
- code: company_not_found
3323+
message: Company Not Found
3324+
schema:
3325+
"$ref": "#/components/schemas/error"
32233326
"/companies/list":
32243327
post:
32253328
summary: List all companies
@@ -21157,6 +21260,27 @@ components:
2115721260
example: 1
2115821261
pages:
2115921262
"$ref": "#/components/schemas/cursor_pages"
21263+
company_note_list:
21264+
title: Paginated Company Notes Response
21265+
type: object
21266+
description: A paginated list of notes associated with a company.
21267+
properties:
21268+
type:
21269+
type: string
21270+
description: String representing the object's type. Always has the value
21271+
`list`.
21272+
example: list
21273+
data:
21274+
type: array
21275+
description: An array of company notes.
21276+
items:
21277+
"$ref": "#/components/schemas/company_note"
21278+
total_count:
21279+
type: integer
21280+
description: A count of the total number of notes.
21281+
example: 1
21282+
pages:
21283+
"$ref": "#/components/schemas/cursor_pages"
2116021284
company_note:
2116121285
title: Company Note
2116221286
type: object

0 commit comments

Comments
 (0)