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

# List WhatsApp conversations (Messages inbox)

**Required scope:** `whatsapp.view`


## OpenAPI

````yaml /api-reference/openapi.json get /whatsapp/conversations
openapi: 3.0.3
info:
  title: Pineyard API
  version: 1.0.0
  description: >-
    Programmatic access to agents, campaigns, calls, phone numbers, WhatsApp and
    results in your Pineyard workspace.
servers:
  - url: https://api.pineyard.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /whatsapp/conversations:
    get:
      summary: List WhatsApp conversations (Messages inbox)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  conversations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        phone:
                          type: string
                        contactId:
                          type: string
                          nullable: true
                        contactName:
                          type: string
                          nullable: true
                        lastMessageAt:
                          type: string
                          nullable: true
                        lastMessagePreview:
                          type: string
                          nullable: true
                        lastMessageDirection:
                          type: string
                          nullable: true
                          enum:
                            - INBOUND
                            - OUTBOUND
                        unreadCount:
                          type: number
                        windowOpen:
                          type: boolean
                        waiting:
                          type: boolean
                        archived:
                          type: boolean
                        callId:
                          type: string
                          nullable: true
                        campaignId:
                          type: string
                          nullable: true
                        campaignName:
                          type: string
                          nullable: true
                        campaignContactId:
                          type: string
                          nullable: true
                        disposition:
                          type: string
                          nullable: true
                        lastStatus:
                          type: string
                          nullable: true
                          enum:
                            - QUEUED
                            - SENT
                            - DELIVERED
                            - READ
                            - FAILED
                        lastFailureReason:
                          type: string
                          nullable: true
                        dispositionSource:
                          type: string
                          nullable: true
                        replied:
                          type: boolean
                        everDelivered:
                          type: boolean
                        everRead:
                          type: boolean
                        everFailed:
                          type: boolean
                        docSent:
                          type: boolean
                        docDelivered:
                          type: boolean
                        docRead:
                          type: boolean
                        clicks:
                          type: number
                        firstClickAt:
                          type: string
                          nullable: true
                      required:
                        - id
                        - phone
                        - contactId
                        - contactName
                        - lastMessageAt
                        - lastMessagePreview
                        - lastMessageDirection
                        - unreadCount
                        - windowOpen
                        - waiting
                        - archived
                        - callId
                        - campaignId
                        - campaignName
                        - campaignContactId
                        - disposition
                        - lastStatus
                        - lastFailureReason
                        - dispositionSource
                        - replied
                        - everDelivered
                        - everRead
                        - everFailed
                        - docSent
                        - docDelivered
                        - docRead
                        - clicks
                        - firstClickAt
                  waitingCount:
                    type: number
                  hasMore:
                    type: boolean
                required:
                  - conversations
                  - waitingCount
                  - hasMore
        '401':
          description: >-
            - `invalid_api_key`: The API key is unknown, revoked or expired, or
            its workspace was deleted.

            - `unauthorized`: No `Authorization: Bearer` header, or an empty
            token.
        '403':
          description: >-
            - `api_key_not_scoped`: A key issued without scopes was used outside
            `/v1`.

            - `api_key_owner_inactive`: The member the key acts for was removed
            or suspended.

            - `forbidden`: The key lacks the permission named in
            `requiredPermission`, or the resource belongs to another workspace.

            - `workspace_pending_approval`: The workspace has not been approved
            yet.

            - `workspace_suspended`: The workspace is suspended.
        '404':
          description: >-
            - `not_found`: The resource does not exist in your workspace, or the
            feature is not enabled for it.
        '429':
          description: '- `rate_limited`: Too many requests.'
        '500':
          description: >-
            - `internal_error`: An unexpected error. A `400` with this code
            usually means the body is not valid JSON; a `413` means the body is
            larger than 1 MB.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your API key, e.g. `pk_live_xxxxxxxxxxxxxxxxxxxxxxxx`.

````

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