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

# Email Open Events

> Returns list of email open event data for given campaign.



## OpenAPI

````yaml /openapi-v1.yml get /api/v1/campaign/email-open-events/
openapi: 3.1.1
info:
  title: DeliverymanAI API V1
  version: 1.0.0
  description: >-
    API documentation for version 1 of the DeliverymanAI API. These endpoints
    drive campaigns, contact lists, leads and email sequences from your own
    code.


    V1 is in maintenance: it keeps working and existing integrations do not need
    to change, but new features are only added to V2. If you are starting a new
    integration, use V2.


    V1 and V2 share the same API keys, sent in the `X-Api-Key` header.
servers:
  - url: https://api.deliveryman.ai
    description: Deliveryman API Server
security: []
paths:
  /api/v1/campaign/email-open-events/:
    get:
      tags:
        - Campaign
      summary: Email Open Events
      description: Returns list of email open event data for given campaign.
      operationId: campaign_email_open_events_retrieve
      parameters:
        - in: query
          name: campaign_uid
          schema:
            title: Campaign Uid
            type: string
          description: UID of campaign to fetch open events from.
          required: true
        - in: query
          name: limit
          schema:
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
          description: >-
            Maximum number of records to fetch in the current page. Must be
            between 1 and 100.
          required: true
        - in: query
          name: offset
          schema:
            minimum: 0
            title: Offset
            type: integer
          description: >-
            Number of records to skip before fetching the results.For example,
            an offset of 0 starts at the beginning, while an offset of 50
            fetches records starting from the 51st. If offset is greater than
            number of records available, results will be empty.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllCampaignEmailOpenEventsAPIResponse'
          description: Success
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleMessageResponse'
          description: Not Found
        '500':
          description: Internal Server Error
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: bash
          label: curl
          source: >-
            curl
            "https://api.deliveryman.ai/api/v1/campaign/email-open-events/?campaign_uid=cmp_4b1f7a92c3d84e05&limit=20&offset=0"
            \
              -H "X-Api-Key: YOUR_API_KEY"
components:
  schemas:
    GetAllCampaignEmailOpenEventsAPIResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetAllCampaignEmailOpenEventsAPI'
          description: List of email open events.
        total:
          type: integer
          minimum: 0
          description: Total number of email open events available in this campaign.
      required:
        - data
        - total
    SimpleMessageResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    GetAllCampaignEmailOpenEventsAPI:
      type: object
      properties:
        schedule_id:
          type: integer
          readOnly: true
          description: ID of the campaign schedule associated with the email open event.
        opened_on:
          type: string
          format: date-time
          description: >-
            The datetime when the email was opened. ISO format date string in
            UTC timezone.
      required:
        - opened_on
        - schedule_id
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        Your API key. In the dashboard, go to Integrations and open Deliveryman
        API Keys to create one.

````

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