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

# Get message receipt

> Retrieve delivery status, open tracking, and click tracking information for a sent message



## OpenAPI

````yaml openapi1 GET /message_receipt
openapi: 3.0.0
info:
  title: Paubox Email API
  description: >
    Public documentation for Paubox's Transactional Email API


    ## Authentication


    **IMPORTANT**: This API uses a custom authentication format that requires
    the "Token token=" prefix.


    All requests must include the Authorization header in this exact format:

    ```

    Authorization: Token token=YOUR_API_KEY

    ```


    **Note for Code Generation Tools**: Auto-generated code from this
    specification may need to be modified to include the "Token token=" prefix,
    as most generators expect standard Bearer token format.
  version: 1.0.0
servers:
  - url: https://api.paubox.net/v1/{api_username}
    description: Paubox Email API
    variables:
      api_username:
        description: Your Paubox Email API endpoint username
        default: YOUR_API_USERNAME
security:
  - PauboxToken: []
tags:
  - name: Messages
    description: Send individual or bulk transactional email
  - name: Dynamic Templates
    description: Manage and use dynamic Handlebars templates for email content
paths:
  /message_receipt:
    get:
      tags:
        - Messages
      summary: Get email disposition
      description: >-
        Retrieve delivery status, open tracking, and click tracking information
        for a sent message
      operationId: getMessageReceipt
      parameters:
        - name: sourceTrackingId
          in: query
          description: The tracking ID returned when the message was sent
          required: true
          schema:
            type: string
            format: uuid
            example: 6e1cf9a4-7bde-4834-8200-ed424b50c8a7
      responses:
        '200':
          description: Message disposition data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageReceiptResponse'
              examples:
                delivered:
                  summary: Delivered message with open and click tracking
                  value:
                    sourceTrackingId: 6e1cf9a4-7bde-4834-8200-ed424b50c8a7
                    data:
                      message:
                        id: >-
                          <f4a9b518-439c-497d-b87f-dfc9cc19194b@authorized_domain.com>
                        message_deliveries:
                          - recipient: recipient@host.com
                            status:
                              deliveryStatus: delivered
                              deliveryTime: Mon, 23 Apr 2018 13:27:34 -0700
                              openedStatus: opened
                              openedTime: Mon, 23 Apr 2018 13:27:51 -0700
                        total_opens: 1
                        distinct_opens: 1
                        total_click_count: 2
                        clicks_per_link:
                          - click_count: 1
                            target_url: amazon.com
                          - click_count: 1
                            target_url: ebay.com
                        unsubscribed: false
        '404':
          description: Message not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageReceiptErrorResponse'
              examples:
                notFound:
                  summary: Message not found
                  value:
                    errors:
                      - code: 404
                        title: Message was not found
                        details: Message with this tracking id was not found
                    sourceTrackingId: 6e1cf9a4-7bde-4834-8d200-ed424b50c8a7
      security:
        - PauboxToken: []
components:
  schemas:
    MessageReceiptResponse:
      required:
        - data
        - sourceTrackingId
      type: object
      properties:
        sourceTrackingId:
          type: string
          description: The tracking ID for the message
          example: 6e1cf9a4-7bde-4834-8200-ed424b50c8a7
        data:
          $ref: '#/components/schemas/MessageReceiptResponse_data'
    MessageReceiptErrorResponse:
      required:
        - errors
        - sourceTrackingId
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponse_errors'
        sourceTrackingId:
          type: string
          description: The tracking ID for the message
          example: 6e1cf9a4-7bde-4834-8d200-ed424b50c8a7
    MessageReceiptResponse_data:
      required:
        - message
      type: object
      properties:
        message:
          $ref: '#/components/schemas/MessageReceiptResponse_data_message'
    ErrorResponse_errors:
      type: object
      properties:
        code:
          type: integer
        title:
          type: string
        details:
          type: string
    MessageReceiptResponse_data_message:
      required:
        - id
        - message_deliveries
      type: object
      properties:
        id:
          type: string
          description: The message ID
          example: <f4a9b518-439c-497d-b87f-dfc9cc19194b@authorized_domain.com>
        message_deliveries:
          type: array
          items:
            $ref: '#/components/schemas/MessageDelivery'
        total_opens:
          type: integer
          description: Total number of opens (single recipient only)
          example: 1
        distinct_opens:
          type: integer
          description: Number of distinct opens (single recipient only)
          example: 1
        total_click_count:
          type: integer
          description: Total number of clicks (single recipient only)
          example: 2
        clicks_per_link:
          type: array
          description: Click tracking data per link (single recipient only)
          items:
            $ref: '#/components/schemas/ClickData'
        unsubscribed:
          type: boolean
          description: Whether the recipient has unsubscribed (single recipient only)
          example: false
    MessageDelivery:
      required:
        - recipient
        - status
      type: object
      properties:
        recipient:
          type: string
          description: The recipient email address
          example: recipient@host.com
        status:
          $ref: '#/components/schemas/DeliveryStatus'
    ClickData:
      required:
        - click_count
        - target_url
      type: object
      properties:
        click_count:
          type: integer
          description: Number of clicks on this specific link
          example: 1
        target_url:
          type: string
          description: The URL that was clicked
          example: amazon.com
    DeliveryStatus:
      required:
        - deliveryStatus
      type: object
      properties:
        deliveryStatus:
          type: string
          description: The delivery status of the message
          example: delivered
          enum:
            - processing
            - TLS not offered, sending via Secure Portal
            - soft bounced
            - soft bounced - mailbox full
            - hard bounced
            - Internal error. Please check back later.
            - delivered
            - delivered via secure portal
        deliveryTime:
          type: string
          description: The time when the message was delivered (if applicable)
          example: Mon, 23 Apr 2018 13:27:34 -0700
        openedStatus:
          type: string
          description: Whether the message was opened (single recipient only)
          example: opened
          enum:
            - opened
            - not opened
        openedTime:
          type: string
          description: The time when the message was first opened (single recipient only)
          example: Mon, 23 Apr 2018 13:27:51 -0700
  securitySchemes:
    PauboxToken:
      type: http
      scheme: bearer
      description: >
        Paubox API uses Bearer token authentication in the Authorization header.


        Format: `Authorization: Bearer YOUR_API_KEY_HERE`


        Example: `Authorization: Bearer
        9e5b092b632445b8f570c62ae54f30fda1044305`


        The legacy format `Authorization: Token token=YOUR_API_KEY_HERE` is also
        supported.

````