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

# List conversations

> Returns conversation threads — inbound/outbound message groups for contacts. Use this to power an inbox view.

Get conversation threads (inbox)

**Response shape:** `data` is a **flat array** of records. This endpoint ignores `page` — the full matching set comes back in one response.



## OpenAPI

````yaml /api-reference/specs/messages.json get /api/messages/conversations
openapi: 3.1.0
info:
  title: ConveYour API — Messages
  description: >-
    Send SMS and email messages to contacts, and manage conversation thread
    assignments.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Messages
    description: >-
      Send SMS and email messages to contacts, and manage conversation thread
      assignments.
paths:
  /api/messages/conversations:
    get:
      tags:
        - Messages
      summary: List conversations
      description: >-
        Returns conversation threads — inbound/outbound message groups for
        contacts. Use this to power an inbox view.


        Get conversation threads (inbox)


        **Response shape:** `data` is a **flat array** of records. This endpoint
        ignores `page` — the full matching set comes back in one response.
      operationId: getConversationThreadsInbox
      parameters:
        - name: type_id
          in: query
          description: Filter to conversations for a specific contact ID.
          schema:
            type: string
        - name: threads
          in: query
          description: >-
            When `true` and `type_id` is set, returns threads for the contact
            rather than the full conversation.
          schema:
            type: boolean
        - name: thread_id
          in: query
          description: Filter to a specific conversation thread.
          schema:
            type: string
        - name: search
          in: query
          description: Search within conversations.
          schema:
            type: string
        - name: closed
          in: query
          description: >-
            When `true`, includes closed/resolved conversations. Default:
            `false`.
          schema:
            type: boolean
        - name: skip
          in: query
          description: 'Number of records to skip for pagination. Default: `0`.'
          schema:
            type: integer
        - name: assigned_to
          in: query
          description: Filter to conversations assigned to a specific user.
          schema:
            type: string
        - name: users
          in: query
          description: >-
            Filter conversations by assigned user IDs. Pass as repeated query
            params.
          schema:
            type: array
            items:
              type: string
        - name: search_type_ids
          in: query
          description: Filter by message type IDs. Pass as repeated query params.
          schema:
            type: array
            items:
              type: string
        - $ref: '#/components/parameters/teams'
        - name: type
          in: query
          required: false
          description: Conversation type. Defaults to `contact`.
          schema:
            type: string
        - name: debug
          in: query
          description: Include debug detail in the response.
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Message'
              example:
                status: ok
                message: success
                data:
                  - thread_id: THREAD_ID
                    contact_id: CONTACT_ID
                    last_message: Hi Jane, how can I help?
                    unread: true
                    closed: false
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    Message:
      type: object
      description: A message.
      properties:
        id:
          type: string
          description: Message ID.
        org_id:
          type: integer
          description: Owning organization.
        user_id:
          type: integer
          description: User who sent it.
        class:
          type: string
          description: Message class, e.g. sms or email.
        type:
          type: string
          description: Recipient type, e.g. `contact` or `bookmark`.
        type_id:
          type: string
          description: ID of the recipient named by `type`.
        body:
          type: string
          description: Message body. Liquid is compiled at send time.
        snippet_id:
          type: string
          description: Snippet the body was built from, if any.
        inputs:
          type: object
          description: Values passed into the template.
        test:
          type: boolean
          description: Whether this is a test send.
        time:
          type: string
          description: Computed per request — relative time, e.g. "3 days ago".
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
      required:
        - class
        - type
        - type_id
        - body
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.