Add side_conversations endpoint to OpenAPI spec#441
Merged
Conversation
Add GET /conversations/{id}/side_conversations endpoint definition and
side_conversation_list / side_conversation_summary schemas for the
Unstable API version.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
adisan19
approved these changes
Apr 10, 2026
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
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.
Why?
The monolith PR (
intercom/intercombranchbusiq/add-side-conversation-threads-api) adds a newGET /conversations/{id}/side_conversationspublic API endpoint. The OpenAPI spec needs to document this endpoint so it appears in the API reference and generated SDKs.How?
Add the path definition and two new schemas (
side_conversation_list,side_conversation_summary) to the Unstable spec, following the existinghandling_eventssub-resource pattern.Companion PRs
intercom/intercom— branchbusiq/add-side-conversation-threads-apiintercom/developer-docs— branchbusiq/add-side-conversations-endpointImplementation Plan
Plan: Add Side Conversations API Documentation
Context
PR
busiq/add-side-conversation-threads-apiintroduces a new public API endpoint:GET /conversations/{id}/side_conversations— returns paginated side conversation threadswith their conversation parts. The endpoint is in
UnstableVersion, gated byAddSideConversationsEndpointversion change, and requiresread_conversations/read_extended_conversationsOAuth scopes.The monolith code is complete. Two companion PRs are needed in external repos to fully ship the API.
Step 1: OpenAPI Spec —
intercom-openapi1a. Add path (after
/conversations/{id}/handling_events)Insert new path
/conversations/{id}/side_conversationsfollowing the exact pattern ofhandling_events— same parameter style, same tag (Conversations), same error responses.Key details from the controller/presenter:
listSideConversationsid(path, required),page(query, integer, default 1),per_page(query, integer, default 25, max 50),Intercom-Version(header)side_conversation_listschema1b. Add schemas (after
handling_event_list)Two new schemas:
side_conversation_summary— object withside_conversation_id(string),conversation_parts(array ofconversation_partrefs),total_count(integer)side_conversation_list— object withtype(enumside_conversation.list),side_conversations(array ofside_conversation_summary),total_count(integer),pages(object withpage,per_page,total_pages)Step 2: Developer Docs —
developer-docsdocs/references/@Unstable/rest-api/Generated with Claude Code