ROrocketlane
Conversations

Get conversation

Changed on

The Get Conversation API allows users to retrieve the conversation history of a specific project using its unique project ID. This endpoint provides a structured and paginated response containing all messages exchanged within the project's conversation thread. This API is designed to facilitate seamless access to project discussions, enabling teams to track conversations, review past messages, and maintain contextual awareness of discussions related to their projects. It is particularly useful for integrations that need to display or analyze communication history.

get/1.0/conversations/{conversationId}

Request

Path parameters

conversationIdinteger required

The ID of the conversation object

Query parameters

includeFieldsstring[]

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeAllFieldsboolean
Example:true

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

Response

The requested action was successfully executed.

conversationNamestring

Conversation name

descriptionstring

Conversation description

allMembersboolean

Conversation all members inclusion

conversationIdinteger

Conversation ID

createdAtinteger

Conversation Created timestamp

privateboolean

Conversation privacy

Example response

{
  "conversationName": "General chat",
  "description": "This is the starting of the General chat",
  "allMembers": true,
  "members": [
    {
      "emailId": "john.doe@rocketlane.com",
      "userId": 201,
      "firstName": "John",
      "lastName": "Doe"
    }
  ],
  "source": {
    "sourceId": 201,
    "sourceType": "PROJECT_CONVERSATION"
  },
  "conversationId": 201,
  "createdAt": 1681319726000,
  "private": true
}

Changes