Skip to content

Commit b87005f

Browse files
markdennis22claude
andcommitted
Add notes field to company API responses
- Added notes field to company schema following the same pattern as contact_notes - Updated example responses for POST /companies and GET /companies/{id} endpoints - Notes field includes type, data array with addressable_list items, url, total_count, and has_more properties 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent ec09a5b commit b87005f

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2680,6 +2680,12 @@ paths:
26802680
plan: {}
26812681
custom_attributes:
26822682
creation_source: api
2683+
notes:
2684+
type: note.list
2685+
data: []
2686+
url: "/companies/6762f0761bb69f9f2193bae2/notes"
2687+
total_count: 0
2688+
has_more: false
26832689
schema:
26842690
"$ref": "#/components/schemas/company"
26852691
'400':
@@ -2902,6 +2908,12 @@ paths:
29022908
segments: []
29032909
plan: {}
29042910
custom_attributes: {}
2911+
notes:
2912+
type: note.list
2913+
data: []
2914+
url: "/companies/6762f07f1bb69f9f2193baf5/notes"
2915+
total_count: 0
2916+
has_more: false
29052917
schema:
29062918
"$ref": "#/components/schemas/company"
29072919
'404':
@@ -16475,6 +16487,37 @@ components:
1647516487
type: array
1647616488
items:
1647716489
"$ref": "#/components/schemas/segment"
16490+
notes:
16491+
type: object
16492+
nullable: false
16493+
description: An object containing notes meta data about the notes that a company
16494+
has. Up to 10 will be displayed here. Use the url to get more.
16495+
properties:
16496+
type:
16497+
type: string
16498+
description: The type of the object
16499+
enum:
16500+
- note.list
16501+
data:
16502+
type: array
16503+
description: This object represents the notes attached to a company.
16504+
items:
16505+
"$ref": "#/components/schemas/addressable_list"
16506+
url:
16507+
type: string
16508+
format: uri
16509+
description: Url to get more notes for this company
16510+
example: "/companies/68d659c788f929561ede8454/notes"
16511+
total_count:
16512+
type: integer
16513+
description: Int representing the total number of notes attached to
16514+
this company
16515+
example: 1
16516+
has_more:
16517+
type: boolean
16518+
description: Whether there's more notes to be viewed. If true,
16519+
use the url to view all
16520+
example: false
1647816521
company_attached_contacts:
1647916522
title: Company Attached Contacts
1648016523
type: object

0 commit comments

Comments
 (0)