> ## Documentation Index
> Fetch the complete documentation index at: https://developers.respondent.io/llms.txt
> Use this file to discover all available pages before exploring further.

> List all conversations for your organization, with optional filters by project or participant.

# Retrieve all conversations



## OpenAPI

````yaml get /v1/messaging/conversations
openapi: 3.0.0
info:
  title: Partner API
  description: Public API for partner integrations
  version: '1.0'
  contact: {}
servers:
  - url: https://api-staging.respondent.io
security: []
tags: []
paths:
  /v1/messaging/conversations:
    get:
      tags:
        - messaging
      summary: Retrieve all conversations
      description: Get all conversations.
      operationId: ConversationsController_findAll
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: x-api-secret
          in: header
          required: true
          schema:
            type: string
        - name: page
          required: false
          in: query
          schema:
            type: number
            default: 1
        - name: pageSize
          required: false
          in: query
          schema:
            type: number
            default: 20
        - name: includeCount
          required: false
          in: query
          schema:
            type: boolean
            default: false
        - name: externalResearcherId
          required: false
          in: query
          description: Filter conversations by externalResearcherId.
          schema:
            type: string
        - name: projectId
          required: false
          in: query
          description: Filter conversations by projectId.
          schema:
            type: string
            format: ObjectId
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationsPaginatedDto'
components:
  schemas:
    ConversationsPaginatedDto:
      type: object
      properties:
        totalResults:
          type: number
          description: >-
            The total number of results possible, which is only provided in the
            response when `includeCount` is passed as `true` within a request.
        page:
          type: number
          default: 1
        pageSize:
          type: number
          default: 50
        results:
          type: array
          items:
            $ref: '#/components/schemas/Conversation'
      required:
        - page
        - pageSize
        - results
    Conversation:
      type: object
      properties:
        createdAt:
          type: string
        updatedAt:
          type: string
        uid:
          type: string
          description: Unique identifier of conversation.
        name:
          type: string
          description: Name of conversation.
        deleted:
          type: boolean
          description: If conversation is marked as deleted.
        locked:
          type: boolean
          description: If conversation is locked.
        read:
          type: boolean
          deprecated: true
        metadata:
          description: Metadata of conversation.
          allOf:
            - $ref: '#/components/schemas/ConversationMetadata'
        user:
          description: >-
            User who created the conversation.

            This will be the API owner/admin account for the api team.

            First name and last name will belong to api team user, not external
            researcher name.

            External researcherId will be stored in metadata, which can be used
            to lookup your external researcher's info internally.
          allOf:
            - $ref: '#/components/schemas/MessagingUser'
        participants:
          description: |-
            All participants of conversation including the researcher.
            The researcher will be the API owner/admin account for the api team.
          type: array
          items:
            $ref: '#/components/schemas/ConversationParticipant'
        messages:
          description: All messages in conversation.
          type: array
          items:
            $ref: '#/components/schemas/MinimalMessage'
        latestMessage:
          description: Latest message in conversation.
          allOf:
            - $ref: '#/components/schemas/LatestMessage'
        messagesCount:
          type: number
          description: Count of messages in conversation.
      required:
        - createdAt
        - uid
        - name
        - deleted
        - locked
        - read
        - user
        - participants
        - messages
        - latestMessage
        - messagesCount
    ConversationMetadata:
      type: object
      properties:
        projectId:
          type: string
          description: ProjectId of the project the coversation belongs to.
          format: ObjectId
        surveyResponseId:
          type: string
          description: ScreenerResponseId for the project, if exists.
          format: ObjectId
        externalResearcherId:
          type: string
          description: ExternalResearcherId for the project, if exists.
        externalTeamId:
          type: string
          description: ExternalTeamId for the project, if exists.
        externalCompanyId:
          type: string
          description: ExternalCompanyId for the project, if exists.
    MessagingUser:
      type: object
      properties:
        uid:
          type: string
          description: Unique identifier for messaging user.
        foreignId:
          type: string
          description: UserId of messaging user.
        firstName:
          type: string
          description: First name of user.
        lastName:
          type: string
          description: Last name initial of user.
      required:
        - uid
        - firstName
        - lastName
    ConversationParticipant:
      type: object
      properties:
        uid:
          type: string
          description: Unique identifier for messaging user.
        foreignId:
          type: string
          description: UserId of messaging user.
        firstName:
          type: string
          description: First name of user.
        lastName:
          type: string
          description: Last name initial of user.
        read:
          type: boolean
          description: Whether the participant has read the conversation.
        deleted:
          type: boolean
          description: Whether the participant has muted the conversation.
      required:
        - uid
        - firstName
        - lastName
        - read
        - deleted
    MinimalMessage:
      type: object
      properties:
        createdAt:
          type: string
        updatedAt:
          type: string
        uid:
          type: string
          description: Unique identifier of message.
        body:
          type: string
          description: Body of message.
        sender:
          description: Sender of message.
          allOf:
            - $ref: '#/components/schemas/MessagingUser'
      required:
        - createdAt
        - uid
        - body
        - sender
    LatestMessage:
      type: object
      properties:
        createdAt:
          type: string
        updatedAt:
          type: string
        uid:
          type: string
          description: Unique identifier for the message.
        body:
          type: string
          description: Body of the message.
      required:
        - createdAt
        - uid
        - body

````