Docs : Add notes support to Company API endpoints #314
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated PUT /companies/{id} endpoint to include notes in response
- Updated GET /companies endpoint to include notes in response
- Updated POST /companies/list endpoint to include notes in response
- Updated GET /companies/scroll endpoint to include notes in response
- Updated POST /contacts/{id}/companies endpoint to include notes in response
All company endpoints now consistently return the notes field with the same structure.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
markdennis22
force-pushed
the
add-get-notes-endpoint
branch
from
45aaa1d to
87ad262
Compare
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]>
markdennis22
force-pushed
the
add-get-notes-endpoint
branch
from
87ad262 to
c31feb0
Compare
markdennis22
changed the title
markdennis22
changed the title
|
@claude this is ready for another look, please review the changes. |
- Changed "List all notes" to "List all company notes" for /companies/{id}/notes
- Changed "List all notes" to "List all contact notes" for /contacts/{id}/notes
This makes the API documentation more specific and clearer about what type of notes each endpoint returns.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary from Issue : 433712
This PR combines the changes from #311 and adds the GET endpoint for company notes:
company_noteandcompany_note_listschemas/companies/{id}/notesto retrieve all notes associated with a companyChanges from PR #434391
Changes from PR #434807
/companies/{id}/notesendpoint definition in the OpenAPI speccompany_note_listschema for paginated company notes responsesNotes Field Structure
The notes field follows the same pattern as
contact_notes:type: "note.list"data: Array of addressable_list items representing note referencesurl: URL to fetch all notes for the companytotal_count: Total number of noteshas_more: Pagination indicatorTest plan
🤖 Generated with Claude Code