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

# List inbox engagement

> Returns persisted account engagement items from supported social providers. Mastodon direct conversations are excluded unless includeDirect is true; Telegram conversations are available with platform=telegram and itemType=telegram_conversation.



## OpenAPI

````yaml /api/openapi.json get /v1/inbox/engagement
openapi: 3.1.0
info:
  title: Kavenio API
  version: 1.0.0
  license:
    name: Proprietary
    url: https://kavenio.com/terms
  description: Generated OpenAPI document for the stable Kavenio public API.
servers:
  - url: https://api.kavenio.com
security:
  - bearerAuth: []
tags:
  - name: API keys
    description: Manage Kavenio API keys for the authenticated user.
  - name: Integrations
    description: Connect automation clients and manage workflow subscriptions.
  - name: Feature requests
    description: Submit feature requests from authenticated users.
  - name: Posts
    description: Create, schedule, update, and manage post lifecycle actions.
  - name: Queue
    description: Manage reusable post queue schedules and preview slots.
  - name: Media
    description: Upload, presign, and validate media assets.
  - name: Validation
    description: Validate post payloads and platform content length limits.
  - name: Connect
    description: Start and complete account connection flows.
  - name: Accounts
    description: Manage connected social accounts and account health.
  - name: Telegram
    description: Manage Telegram-specific connected account settings.
  - name: Discord
    description: Manage Discord messages, roles, pins, events, and settings.
  - name: Google Business
    description: Manage Google Business locations, reviews, and helpers.
  - name: Ads
    description: Create, read, cancel, and inspect advertising resources.
  - name: Ad audiences
    description: Manage advertising audiences and audience members.
  - name: Ad catalogs
    description: Inspect advertising catalogs and product sets.
  - name: Ad targeting
    description: Search targeting entities and estimate audience reach.
  - name: Ad conversions
    description: Manage conversion destinations and send conversion events.
  - name: Ad leads
    description: Manage lead forms and retrieve advertising leads.
  - name: Tracking tags
    description: Manage Meta tracking tags and tag sharing.
  - name: Platform credentials
    description: Manage organization platform app credentials.
  - name: Analytics
    description: Read provider analytics and operational inbox data.
  - name: WhatsApp conversions
    description: Read and send WhatsApp conversion events.
  - name: Activity
    description: Read operational activity events.
  - name: Webhooks
    description: Manage webhook endpoints and delivery logs.
paths:
  /v1/inbox/engagement:
    get:
      tags:
        - Analytics
      summary: List inbox engagement
      description: >-
        Returns persisted account engagement items from supported social
        providers. Mastodon direct conversations are excluded unless
        includeDirect is true; Telegram conversations are available with
        platform=telegram and itemType=telegram_conversation.
      operationId: listInboxEngagement
      parameters:
        - in: query
          name: profileId
          schema:
            type: string
            minLength: 1
            maxLength: 255
        - in: query
          name: platform
          schema:
            type: string
            enum:
              - mastodon
              - telegram
        - in: query
          name: accountId
          schema:
            type: string
            minLength: 16
            maxLength: 16
            pattern: ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
        - in: query
          name: itemType
          schema:
            anyOf:
              - type: string
                enum:
                  - notification
                  - conversation
                  - status_reply
              - type: string
                const: telegram_conversation
        - in: query
          name: notificationType
          schema:
            type: string
            enum:
              - mention
              - status
              - reblog
              - follow
              - follow_request
              - favourite
              - poll
              - update
              - admin.sign_up
              - admin.report
              - severed_relationships
              - moderation_warning
              - unknown
        - in: query
          name: unreadOnly
          schema:
            anyOf:
              - type: boolean
              - type: string
                const: 'true'
              - type: string
                const: 'false'
        - in: query
          name: includeDirect
          schema:
            anyOf:
              - type: boolean
              - type: string
                const: 'true'
              - type: string
                const: 'false'
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - in: query
          name: cursor
          schema:
            type: string
            minLength: 1
      responses:
        '200':
          description: List inbox engagement completed.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      ok:
                        type: boolean
                        x-kavenio-const: true
                      data:
                        type: object
                        properties:
                          status:
                            type: string
                            minLength: 1
                          data:
                            type: array
                            items:
                              anyOf:
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      minLength: 16
                                      maxLength: 16
                                      pattern: >-
                                        ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                                    platform:
                                      type: string
                                      const: mastodon
                                    accountId:
                                      type: string
                                      minLength: 16
                                      maxLength: 16
                                      pattern: >-
                                        ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                                    profileId:
                                      type: string
                                      minLength: 1
                                      maxLength: 255
                                    itemType:
                                      type: string
                                      enum:
                                        - notification
                                        - conversation
                                        - status_reply
                                    providerItemId:
                                      type: string
                                      minLength: 1
                                    notificationType:
                                      type: string
                                      enum:
                                        - mention
                                        - status
                                        - reblog
                                        - follow
                                        - follow_request
                                        - favourite
                                        - poll
                                        - update
                                        - admin.sign_up
                                        - admin.report
                                        - severed_relationships
                                        - moderation_warning
                                        - unknown
                                    providerStatusId:
                                      type: string
                                      minLength: 1
                                    providerConversationId:
                                      type: string
                                      minLength: 1
                                    actor:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                          minLength: 1
                                        username:
                                          type: string
                                          minLength: 1
                                        acct:
                                          type: string
                                          minLength: 1
                                        displayName:
                                          type: string
                                        url:
                                          type: string
                                          format: uri
                                        avatar:
                                          type: string
                                          format: uri
                                      required:
                                        - id
                                      additionalProperties: false
                                    status:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                          minLength: 1
                                        uri:
                                          type: string
                                          minLength: 1
                                        url:
                                          type: string
                                          format: uri
                                        contentHtml:
                                          type: string
                                        text:
                                          type: string
                                        createdAt:
                                          type: string
                                          minLength: 1
                                        visibility:
                                          type: string
                                          minLength: 1
                                        sensitive:
                                          type: boolean
                                        spoilerText:
                                          type: string
                                        repliesCount:
                                          type: integer
                                          minimum: 0
                                          maximum: 9007199254740991
                                        reblogsCount:
                                          type: integer
                                          minimum: 0
                                          maximum: 9007199254740991
                                        favouritesCount:
                                          type: integer
                                          minimum: 0
                                          maximum: 9007199254740991
                                        favourited:
                                          type: boolean
                                        reblogged:
                                          type: boolean
                                        bookmarked:
                                          type: boolean
                                        muted:
                                          type: boolean
                                        account:
                                          type: object
                                          properties:
                                            id:
                                              type: string
                                              minLength: 1
                                            username:
                                              type: string
                                              minLength: 1
                                            acct:
                                              type: string
                                              minLength: 1
                                            displayName:
                                              type: string
                                            url:
                                              type: string
                                              format: uri
                                            avatar:
                                              type: string
                                              format: uri
                                          required:
                                            - id
                                          additionalProperties: false
                                        inReplyToId:
                                          type: string
                                          minLength: 1
                                        inReplyToAccountId:
                                          type: string
                                          minLength: 1
                                        raw:
                                          type: object
                                          propertyNames:
                                            type: string
                                          additionalProperties: {}
                                      required:
                                        - id
                                      additionalProperties: false
                                    isRead:
                                      type: boolean
                                    isDismissed:
                                      type: boolean
                                    occurredAt:
                                      type: string
                                      minLength: 1
                                    fetchedAt:
                                      type: string
                                      minLength: 1
                                    createdAt:
                                      type: string
                                      minLength: 1
                                    updatedAt:
                                      type: string
                                      minLength: 1
                                  required:
                                    - id
                                    - platform
                                    - accountId
                                    - profileId
                                    - itemType
                                    - providerItemId
                                    - isRead
                                    - isDismissed
                                    - occurredAt
                                    - fetchedAt
                                    - createdAt
                                    - updatedAt
                                  additionalProperties: false
                                - type: object
                                  properties:
                                    id:
                                      type: string
                                      minLength: 16
                                      maxLength: 16
                                      pattern: >-
                                        ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                                    accountId:
                                      type: string
                                      minLength: 16
                                      maxLength: 16
                                      pattern: >-
                                        ^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$
                                    profileId:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    providerChatId:
                                      type: string
                                      minLength: 1
                                    providerUserId:
                                      type: string
                                      minLength: 1
                                    username:
                                      type: string
                                      minLength: 1
                                    displayName:
                                      type: string
                                      minLength: 1
                                    firstName:
                                      type: string
                                      minLength: 1
                                    lastName:
                                      type: string
                                      minLength: 1
                                    lastMessageText:
                                      anyOf:
                                        - type: string
                                        - type: 'null'
                                    lastMessageAt:
                                      anyOf:
                                        - type: string
                                          minLength: 1
                                        - type: 'null'
                                    archivedAt:
                                      anyOf:
                                        - type: string
                                          minLength: 1
                                        - type: 'null'
                                    createdAt:
                                      type: string
                                      minLength: 1
                                    updatedAt:
                                      type: string
                                      minLength: 1
                                    platform:
                                      type: string
                                      const: telegram
                                    itemType:
                                      type: string
                                      const: telegram_conversation
                                    providerItemId:
                                      type: string
                                      minLength: 1
                                    isRead:
                                      type: boolean
                                    isDismissed:
                                      type: boolean
                                    occurredAt:
                                      type: string
                                      minLength: 1
                                    fetchedAt:
                                      type: string
                                      minLength: 1
                                  required:
                                    - id
                                    - accountId
                                    - providerChatId
                                    - providerUserId
                                    - createdAt
                                    - updatedAt
                                    - platform
                                    - itemType
                                    - providerItemId
                                    - isRead
                                    - isDismissed
                                    - occurredAt
                                    - fetchedAt
                                  additionalProperties: false
                          pagination:
                            type: object
                            properties:
                              hasMore:
                                type: boolean
                              nextCursor:
                                type: string
                                minLength: 1
                            required:
                              - hasMore
                            additionalProperties: false
                          meta:
                            type: object
                            properties:
                              platforms:
                                type: array
                                items:
                                  type: string
                                  enum:
                                    - mastodon
                                    - telegram
                              accountsQueried:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              directIncluded:
                                type: boolean
                              lastUpdated:
                                type: string
                                minLength: 1
                            required:
                              - platforms
                              - accountsQueried
                              - directIncluded
                              - lastUpdated
                            additionalProperties: false
                          summary:
                            type: object
                            properties:
                              totalItems:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              unreadItems:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                              directItems:
                                type: integer
                                minimum: 0
                                maximum: 9007199254740991
                            required:
                              - totalItems
                              - unreadItems
                              - directItems
                            additionalProperties: false
                        required:
                          - status
                          - data
                          - pagination
                          - meta
                          - summary
                        additionalProperties: false
                    required:
                      - ok
                      - data
                    additionalProperties: false
                  - type: object
                    properties:
                      ok:
                        type: boolean
                        x-kavenio-const: false
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            minLength: 1
                          message:
                            type: string
                            minLength: 1
                          details: {}
                        required:
                          - code
                          - message
                        additionalProperties: false
                    required:
                      - ok
                      - error
                    additionalProperties: false
        '401':
          description: Authentication failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '422':
          description: Request validation failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '500':
          description: Request failed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    x-kavenio-const: false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        minLength: 1
                      message:
                        type: string
                        minLength: 1
                      details: {}
                    required:
                      - code
                      - message
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Clerk session or OAuth token

````