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

# List inbox items

> Lists the receipts found in the current user's connected email accounts (receipt inbox). Requires the receipt inbox to be enabled for the user. Inbox items are always sorted by `receivedAt` descending (newest first); custom sorting is not supported.



## OpenAPI

````yaml /openapi/findity-expense-api.json get /me/inboxitems
openapi: 3.0.3
info:
  title: Findity Expense API
  description: Findity Expense API
  version: 1.0.0
servers:
  - url: https://stage-api.findity.com/api/v1/expense
  - url: https://api.findity.com/api/v1/expense
security:
  - bearerAuth: []
paths:
  /me/inboxitems:
    get:
      tags:
        - Inbox
      summary: List inbox items
      description: >-
        Lists the receipts found in the current user's connected email accounts
        (receipt inbox). Requires the receipt inbox to be enabled for the user.
        Inbox items are always sorted by `receivedAt` descending (newest first);
        custom sorting is not supported.
      operationId: listInboxItems
      parameters:
        - $ref: '#/components/parameters/inboxItemInclude'
        - $ref: '#/components/parameters/accountId'
        - $ref: '#/components/parameters/max'
        - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArrayOfInboxItems'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/findity-api-error-exception'
              examples:
                receiptInboxNotEnabled:
                  summary: Receipt inbox not enabled
                  description: >-
                    This error occurs when the receipt inbox is not enabled for
                    the user.
                  value:
                    result: error
                    code: RECEIPT_INBOX_NOT_ENABLED
                    description: Receipt inbox is not enabled for this account.
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
              example:
                result: error
                description: Not authorized
components:
  parameters:
    inboxItemInclude:
      name: include
      in: query
      description: >-
        Optional. Array of strings, comma-separated. Additional properties to
        include in the response. Accepted values: `meta.abbreviation` adds
        `meta.abbreviation` to each inbox item, with pre-formatted, localized
        strings for displaying it (date, description, attachment, amount and
        labels). When omitted, `meta` is not returned.
      required: false
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          enum:
            - meta.abbreviation
    accountId:
      name: accountId
      in: query
      description: >-
        Optional. String. Identifier of a connected email account, the same
        value as the `userId` property of an inbox item. When given, only inbox
        items received through that account are returned. When omitted, inbox
        items from all of the user's connected accounts are returned.
      required: false
      schema:
        type: string
        example: jane.doe@example.com
    max:
      name: max
      in: query
      description: max records to return
      required: false
      schema:
        type: integer
        format: int
        minimum: 1
        maximum: 1000
        default: 10
    offset:
      name: offset
      in: query
      description: the offset to be used in list
      required: false
      schema:
        type: integer
        format: int
        minimum: 0
        default: 0
  schemas:
    ArrayOfInboxItems:
      type: object
      required:
        - meta
        - data
      properties:
        meta:
          type: object
          required:
            - count
            - total
          properties:
            count:
              type: integer
              description: Number of inbox items in this page
            total:
              type: integer
              description: Total number of inbox items
        data:
          type: array
          items:
            $ref: '#/components/schemas/InboxItem'
      example:
        meta:
          count: 2
          total: 2
        data:
          - id: e4677839-5f0a-4c7e-9a1b-2d3c4e5f6a7b
            userId: jane.doe@example.com
            provider: GMAIL
            subject: 'Fwd: Hetzner Online GmbH - Invoice 086000959937'
            senderEmail: jane.doe@example.com
            senderName: Jane Doe
            bodyPreview: Dear customer, please find your invoice attached...
            receivedAt: '2026-09-23T08:46:50Z'
            detectedAmount: 10.61
            detectedCurrency: EUR
            used: false
            status: AVAILABLE
            hasAttachments: true
            attachmentTypes:
              - application/pdf
            attachments:
              - id: 7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f
                type: application/pdf
                filename: invoice.pdf
                sizeBytes: 48213
                stored: true
                hasOcrText: true
                shouldInclude: true
                previewAvailable: false
          - id: b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e
            userId: jane.doe@example.com
            provider: GMAIL
            subject: Your receipt from SJ
            senderEmail: no-reply@sj.se
            senderName: SJ
            bodyPreview: Thank you for travelling with SJ...
            receivedAt: '2026-09-20T14:02:11Z'
            detectedAmount: 495
            detectedCurrency: SEK
            expenseId: 671700c30ed84764a5e14518836d262f
            used: true
            status: EXPENSED
            hasAttachments: false
            attachmentTypes: []
            attachments: []
    findity-api-error-exception:
      type: object
      properties:
        result:
          type: string
        code:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        data:
          type: object
          nullable: true
      required:
        - result
    401Error:
      type: object
      properties:
        result:
          type: string
        description:
          type: string
    InboxItem:
      type: object
      description: >-
        A receipt found in one of the user's connected email accounts.
        Properties without a value are left out.
      required:
        - id
        - userId
        - provider
        - receivedAt
        - used
        - status
        - hasAttachments
        - attachmentTypes
        - attachments
      properties:
        id:
          type: string
          format: uuid
          description: Id of the inbox item
        userId:
          type: string
          description: >-
            Identifier of the connected email account the receipt was received
            through. Pass it as `accountId` to `GET /me/inboxitems` to list only
            the inbox items from that account.
        provider:
          type: string
          enum:
            - GMAIL
            - OUTLOOK
          description: Email provider the receipt was received through
        subject:
          type: string
          description: Subject of the email
        senderEmail:
          type: string
          description: Email address of the sender
        senderName:
          type: string
          description: Name of the sender
        bodyPreview:
          type: string
          description: The beginning of the email body
        receivedAt:
          type: string
          format: date-time
          description: When the email was received
        detectedAmount:
          type: number
          description: Amount detected in the receipt
        detectedCurrency:
          type: string
          description: ISO 4217 currency code of the detected amount
        expenseId:
          type: string
          description: Id of the expense the inbox item is linked to
        used:
          type: boolean
          description: >-
            Whether the inbox item is linked to an expense (true when
            `expenseId` is set)
        status:
          type: string
          enum:
            - AVAILABLE
            - PENDING
            - EXPENSED
          description: >-
            Status of the inbox item: `AVAILABLE` (not linked to an expense),
            `PENDING` (an expense is being created from it) or `EXPENSED`
            (linked to an expense)
        hasAttachments:
          type: boolean
          description: Whether the email has attachments
        attachmentTypes:
          type: array
          description: Content types of the attachments
          items:
            type: string
        attachments:
          type: array
          description: Attachments of the email
          items:
            $ref: '#/components/schemas/InboxItemAttachment'
        meta:
          type: object
          description: Returned only when requested with the `include` parameter
          properties:
            abbreviation:
              $ref: '#/components/schemas/InboxItemAbbreviation'
      example:
        id: e4677839-5f0a-4c7e-9a1b-2d3c4e5f6a7b
        userId: jane.doe@example.com
        provider: GMAIL
        subject: 'Fwd: Hetzner Online GmbH - Invoice 086000959937'
        senderEmail: jane.doe@example.com
        senderName: Jane Doe
        bodyPreview: Dear customer, please find your invoice attached...
        receivedAt: '2026-09-23T08:46:50Z'
        detectedAmount: 10.61
        detectedCurrency: EUR
        used: false
        status: AVAILABLE
        hasAttachments: true
        attachmentTypes:
          - application/pdf
        attachments:
          - id: 7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f
            type: application/pdf
            filename: invoice.pdf
            sizeBytes: 48213
            stored: true
            hasOcrText: true
            shouldInclude: true
            previewAvailable: false
        meta:
          abbreviation:
            dateDescription: 23 september 2026
            userDescription: 'Fwd: Hetzner Online GmbH - Invoice 086000959937'
            attachmentDescription: invoice.pdf
            originalAmountDescription: 10,61 EUR
            labels:
              - property: label.notConnectedToExpense
                text: Not linked to expense
                priority: NORMAL
                type: NORMAL
    InboxItemAttachment:
      type: object
      description: An attachment of an inbox item
      required:
        - id
        - stored
        - hasOcrText
        - shouldInclude
        - previewAvailable
      properties:
        id:
          type: string
          format: uuid
          description: Id of the attachment
        type:
          type: string
          description: Content type of the attachment
        filename:
          type: string
          description: File name of the attachment
        sizeBytes:
          type: integer
          format: int64
          description: Size of the attachment in bytes
        stored:
          type: boolean
          description: Whether the attachment has been stored
        hasOcrText:
          type: boolean
          description: Whether text has been extracted from the attachment
        shouldInclude:
          type: boolean
          description: Whether the attachment is considered part of the receipt
        previewAvailable:
          type: boolean
          description: Whether a preview of the attachment is available
    InboxItemAbbreviation:
      type: object
      description: >-
        Pre-formatted, localized strings for displaying the inbox item. Returned
        when `include=meta.abbreviation` is passed.
      properties:
        dateDescription:
          type: string
          description: Formatted date the email was received
        userDescription:
          type: string
          description: Short description of the inbox item (the email subject)
        attachmentDescription:
          type: string
          description: File name of the receipt attachment
        originalAmountDescription:
          type: string
          description: Formatted detected amount with currency
        labels:
          type: array
          description: >-
            Labels for the inbox item. Always exactly one label telling whether
            the inbox item is linked to an expense: `label.connectedToExpense`
            (SUCCESS), `label.expensePending` (INFORMATION) or
            `label.notConnectedToExpense` (NORMAL).
          items:
            $ref: '#/components/schemas/ExpenseLabel'
    ExpenseLabel:
      type: object
      description: Label for an expense or expense report
      properties:
        property:
          type: string
          description: The property this label relates to
          example: label.autoApproval
        text:
          type: string
          description: The label text to display
          example: Auto-approved
        priority:
          type: string
          enum:
            - NORMAL
            - IMPORTANT
            - CRITICAL
          description: Priority level of the label
          example: NORMAL
        type:
          type: string
          enum:
            - NORMAL
            - SUCCESS
            - INFORMATION
            - WARNING
            - ERROR
          description: Type of label indicating its semantic meaning
          example: SUCCESS
        iconUrl:
          type: string
          description: Optional URL to an icon for the label
          example: https://expense.findity.com/api/resources/ic_ai_sparkles.svg
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````