Skip to content

Conversation

markdennis22
Copy link

@markdennis22 markdennis22 commented Sep 30, 2025

Summary from Issue : 433712

This PR combines the changes from #311 and adds the GET endpoint for company notes:

  • Added notes field to all company API endpoint responses
  • Added company_note and company_note_list schemas
  • Added new GET endpoint /companies/{id}/notes to retrieve all notes associated with a company

Changes from PR #434391

  • 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

Changes from PR #434807

  • Added GET /companies/{id}/notes endpoint definition in the OpenAPI spec
  • Created company_note_list schema for paginated company notes responses
  • Included proper error handling for when a company is not found (404 response)

Notes Field Structure

The notes field follows the same pattern as contact_notes:

  • type: "note.list"
  • data: Array of addressable_list items representing note references
  • url: URL to fetch all notes for the company
  • total_count: Total number of notes
  • has_more: Pagination indicator

Test plan

  • Verify the OpenAPI spec validates correctly
  • Test that company endpoints return notes field correctly
  • Test the new GET /companies/{id}/notes endpoint returns notes for valid company IDs
  • Verify 404 response for invalid company IDs
  • Ensure pagination works as expected

🤖 Generated with Claude Code

markdennis22 and others added 4 commits September 29, 2025 18:16
- 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 <noreply@anthropic.com>
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 <noreply@anthropic.com>
@markdennis22 markdennis22 changed the title Add GET /companies/{id}/notes endpoint Add notes support to Company API endpoints Sep 30, 2025
@markdennis22 markdennis22 marked this pull request as ready for review October 2, 2025 12:43
@markdennis22 markdennis22 changed the title Add notes support to Company API endpoints Docs : Add notes support to Company API endpoints Oct 3, 2025
@markdennis22 markdennis22 requested a review from a team October 3, 2025 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant