ROrocketlane
Conversations

Get all conversations

Changed on

The Get All Conversations API allows users to retrieve all conversations within a specified project using its unique project ID. This endpoint returns a paginated response containing all available conversation threads for the specified project, along with metadata such as timestamps, sender details, and message status. This API is designed to facilitate seamless access to project discussions, enabling teams to track, review, and analyze past conversations for better collaboration and project management.

get/1.0/conversations

Request

Query parameters

pageSizenumber
Example:100

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFieldsstring[]

Use this query parameter to opt in for fields to be returned in the response body. Use comma separated values to fetch the respective fields. If left blank, 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.

sourceId.eqnumber
Example:123

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.

conversationName.eqstring
Example:New channel

Filter by conversation name

conversationName.cnstring
Example:New channel

You can use this param to specify some Conversation name and the responses will contain matches of conversation that match the given name.

conversationName.ncstring
Example:New channel

You can use this param to specify some Conversation name and the responses will not contain matches of conversation that match the given name.

isPrivate.eqboolean
Example:true

Filter by private conversations

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "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
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/projects/1/conversations?includeFields=category,minutes&billable.eq=false&sortBy=startDate&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100&assignee.any=1&startDate.gt=2022-01-02",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}

Changes