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

# List conversations

> Lists the workspace's conversations, most recently active first, with cursor pagination. Filter by status, channel, assigned agent, or contact, and search with `q` the same way console search works (subject, customer name/email, and message bodies).



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/conversations
openapi: 3.1.0
info:
  title: Adraa Inbox API
  description: >-
    Public REST API for Adraa Inbox. Assign agents to conversations and send
    messages from your own systems. Authenticate every request with a workspace
    API token.
  version: 1.0.0
  contact:
    email: support@adraa.ai
servers:
  - url: https://api.inbox.adraa.ai
    description: Production
security:
  - apiToken: []
paths:
  /api/v1/conversations:
    get:
      summary: List conversations
      description: >-
        Lists the workspace's conversations, most recently active first, with
        cursor pagination. Filter by status, channel, assigned agent, or
        contact, and search with `q` the same way console search works (subject,
        customer name/email, and message bodies).
      operationId: listConversations
      parameters:
        - name: status
          in: query
          description: >-
            `open` — not closed; `closed`; `unassigned` — open and without an
            assigned agent; `all` — everything.
          schema:
            type: string
            enum:
              - open
              - closed
              - unassigned
              - all
            default: all
        - name: channel
          in: query
          description: Only conversations on this channel.
          schema:
            type: string
            enum:
              - web
              - whatsapp
              - facebook
              - telegram
              - sms
              - email
        - name: agentId
          in: query
          description: >-
            Only conversations assigned to this agent (list agents with `GET
            /api/v1/agents`).
          schema:
            type: string
            example: cmbxgwq1e0000ph01i0j1k2l3
        - name: contactId
          in: query
          description: >-
            Only this contact's conversations (list contacts with `GET
            /api/v1/contacts`).
          schema:
            type: string
            example: cmbxgy7kq0002ph01u2v3w4x5
        - name: q
          in: query
          description: >-
            Search term. Matches the subject, the contact's name and email, and
            message bodies.
          schema:
            type: string
            maxLength: 160
            example: refund
        - name: cursor
          in: query
          description: The `nextCursor` from the previous page. Omit for the first page.
          schema:
            type: string
        - name: limit
          in: query
          description: Conversations per page.
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: sort
          in: query
          description: >-
            `updated` (default) orders by last activity — the inbox order.
            `created` orders newest-first by creation, for polling new
            conversations (e.g. Zapier dedupes by the stable `id`).
          schema:
            type: string
            enum:
              - updated
              - created
            default: updated
      responses:
        '200':
          description: One page of conversations
          content:
            application/json:
              schema:
                type: object
                properties:
                  conversations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Conversation'
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `cursor` to fetch the next page. `null` when this
                      is the last page.
                    example: cmbxgz9pq0003ph01m4n5o6p7
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Conversation:
      type: object
      properties:
        id:
          type: string
          description: Conversation ID — use it to assign agents or send messages.
          example: cmbxgz9pq0003ph01m4n5o6p7
        channel:
          type: string
          enum:
            - web
            - whatsapp
            - facebook
            - telegram
            - sms
            - email
          example: whatsapp
        subject:
          type:
            - string
            - 'null'
          description: Subject line, mainly for email conversations.
          example: null
        status:
          type: string
          description: '`open` or `closed`.'
          example: open
        contact:
          type: object
          description: The customer in this conversation.
          properties:
            id:
              type: string
              example: cmbxgy7kq0002ph01u2v3w4x5
            name:
              type: string
              example: Sara Al-Harbi
            email:
              type:
                - string
                - 'null'
              example: sara@example.com
            phone:
              type:
                - string
                - 'null'
              example: '+966501234567'
        assignment:
          type:
            - object
            - 'null'
          description: The assigned agent, or `null` when unassigned.
          properties:
            agentId:
              type: string
              example: cmbxgwq1e0000ph01i0j1k2l3
            agentNickname:
              type: string
              example: sara
            assignedAt:
              type: string
              format: date-time
              example: '2026-06-12T10:30:00.000Z'
        lastMessage:
          type:
            - object
            - 'null'
          description: The most recent non-system message.
          properties:
            id:
              type: string
              example: cmbxh2k3a0001ph01q8r9s0t1
            body:
              type: string
              example: Thanks, that fixed it!
            senderId:
              type: string
              example: cmbxgy7kq0002ph01u2v3w4x5
            senderType:
              type: string
              enum:
                - customer
                - agent
              example: customer
            status:
              type: string
              enum:
                - sent
                - delivered
                - read
                - failed
                - deleted
              example: read
            createdAt:
              type: string
              format: date-time
              example: '2026-06-12T10:29:00.000Z'
        createdAt:
          type: string
          format: date-time
          example: '2026-06-10T07:15:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-06-12T10:30:00.000Z'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable explanation.
            details:
              description: Field-level details for validation errors.
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_API_TOKEN
              message: Invalid or revoked API token
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: >-
        Workspace API token created in Settings → API. Tokens start with
        `adraa_`.

````