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

# List email events

> List email events for the organization.

export const EndpointPath = ({type, path}) => {
  return <div class="flex w-full flex-col bg-background-light dark:bg-background-dark border-standard rounded-2xl p-1.5">
      <div class="flex items-center space-x-1.5">
        <div class="relative flex-1 flex gap-2 min-w-0 rounded-xl items-center cursor-pointer p-1.5 border-standard">
          <div class="rounded-lg font-bold px-1.5 py-0.5 text-sm leading-5 bg-blue-400/20 dark:bg-blue-400/20 text-blue-700 dark:text-blue-400">
            POST
          </div>
          <div class="flex items-center space-x-2 overflow-x-auto flex-1 no-scrollbar">
            <div class="group flex items-center flex-1 gap-0.5 font-mono">
              <div class="absolute right-0 p-2 bg-background-light dark:bg-background-dark rounded-lg hidden group-hover:block">
                <svg class="w-4 h-4 bg-gray-400 dark:bg-white/30"></svg>
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                public
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                v1
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                {type}
              </div>
              <div class="text-sm text-gray-400">/</div>
              <div class="text-sm font-medium text-gray-800 dark:text-white min-w-max">
                {path}
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>;
};

export const NestedParam = ({parentKey, childKey, type, required, description, children}) => {
  const fullKey = `${parentKey}.${childKey}`;
  const anchorId = `body-${fullKey.replace(/\./g, '-')}`;
  return <div className="py-6 border-gray-100 dark:border-gray-800 border-b last:border-b-0">
  <div className="flex font-mono text-sm group/param-head param-head break-all relative" id={anchorId}>
    <div className="flex-1 flex content-start py-0.5 mr-5">
      <div className="flex items-center flex-wrap gap-2">
        <div className="absolute -top-1.5">
          <a href={`#${anchorId}`} className="-ml-[2.1rem] flex items-center opacity-0 border-0 group-hover/param-head:opacity-100 py-2 [.expandable-content_&]:-ml-[2.1rem]" aria-label="Navigate to header">
            <div className="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20">
              <svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512">
                <path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path>
              </svg>
            </div>
          </a>
        </div>
        <div className="font-semibold text-primary dark:text-primary-light cursor-pointer overflow-wrap-anywhere">
          <span className="text-gray-500 dark:text-gray-400">{parentKey}.</span>
          {childKey}
        </div>
        <div className="inline items-center gap-2 text-xs font-medium [&_div]:inline [&_div]:mr-2 [&_div]:leading-5">
          <div className="flex items-center px-2 py-0.5 rounded-md bg-gray-100/50 dark:bg-white/5 text-gray-600 dark:text-gray-200 font-medium break-all">
            <span>{type}</span>
          </div>
          {required && <span className="px-2 py-0.5 rounded-md bg-red-100/50 dark:bg-red-400/10 text-red-600 dark:text-red-300 font-medium whitespace-nowrap">
              required
            </span>}
        </div>
      </div>
    </div>
  </div>
  {children && <div className="mt-4">
      <div className="prose prose-sm prose-gray dark:prose-invert">
        {children}
      </div>
    </div>}
</div>;
};

export const H3Bordered = ({text}) => <h3 id={text.toLowerCase()} className="border-b pb-2.5 border-gray-100 dark:border-gray-800">
    {text}
  </h3>;

export const Authorizations = () => {
  return <div>
      <H3Bordered text="Authorizations" />

      <Tabs>
        <Tab title="API Key">
          <div className="flex text-sm group/param-head param-head break-all relative" id="authorization-x-stamp">
            <ParamField header="X-Stamp" type="string" required={true}>
              Cryptographically signed (stamped) request to be passed in as a header. For more info, see <a href="https://docs.turnkey.com/developer-reference/api-overview/stamps">here</a>.
            </ParamField>
          </div>
        </Tab>

        <Tab title="WebAuthn (Passkey)">
         <div className="flex text-sm group/param-head param-head break-all relative" id="authorization-x-stamp-webauthn">
            <ParamField body="X-Stamp-WebAuthn" type="string" required={true}>
              Cryptographically signed (stamped) request to be passed in as a header. For more info, see <a href="https://docs.turnkey.com/developer-reference/api-overview/stamps">here</a>.
            </ParamField>
          </div>
        </Tab>
      </Tabs>
    </div>;
};

<EndpointPath type="query" path="list_email_events" />

<Authorizations />

<H3Bordered text="Body" />

<ParamField body="organizationId" type="string" required={true}>
  Unique identifier for a given organization
</ParamField>

<ParamField body="email" type="string" required={true}>
  Recipient email address to list email events for
</ParamField>

<ParamField body="eventType" type="string" required={false}>
  Optional email event type to filter by. Examples include Send, Delivery, Bounce, and DeliveryDelay
</ParamField>

<ParamField body="paginationOptions" type="object" required={false} path="paginationOptions">
  <p>paginationOptions field</p>

  <Expandable title="details">
    <NestedParam parentKey="paginationOptions" childKey="limit" type="string" required={false} default="">
      A limit of the number of object to be returned, between 1 and 100. Defaults to 10.
    </NestedParam>

    <NestedParam parentKey="paginationOptions" childKey="before" type="string" required={false} default="">
      A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.
    </NestedParam>

    <NestedParam parentKey="paginationOptions" childKey="after" type="string" required={false} default="">
      A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.
    </NestedParam>
  </Expandable>
</ParamField>

<H3Bordered text="Response" />

A successful response returns the following fields:

<ResponseField name="emailEvents" type="array" required={true}>
  Email events matching the requested filters, ordered by most recent event first.

  <Expandable title="emailEvents details">
    <NestedParam parentKey="emailEvents" childKey="id" type="string" required={true}>
      Unique identifier for the email event
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="organizationId" type="string" required={true}>
      Unique identifier for the organization associated with the email event
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="messageId" type="string" required={true}>
      Provider message identifier. Multiple events can share the same message ID
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="eventType" type="string" required={true}>
      Email event type, such as Send, Delivery, Bounce, or DeliveryDelay
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="fromAddress" type="string" required={true}>
      Sender email address
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="toAddress" type="string" required={true}>
      Recipient email address
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="senderTenant" type="string" required={false}>
      SES tenant that sent the email, when available
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="timestamp" type="string" required={true}>
      Event timestamp as millisecond epoch string
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="createdAt" type="string" required={true}>
      Creation timestamp as millisecond epoch string
    </NestedParam>

    <NestedParam parentKey="emailEvents" childKey="details" type="object" required={true}>
      details field

      <Expandable title="details details">
        <NestedParam parentKey="emailEvents.details" childKey="bounceType" type="string" required={false}>
          Bounce type for Bounce events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="bounceSubType" type="string" required={false}>
          Bounce subtype for Bounce events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="diagnosticCode" type="string" required={false}>
          Diagnostic text for Bounce or DeliveryDelay events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="deliverySmtpResponse" type="string" required={false}>
          SMTP response for Delivery events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="deliveryProcessingTimeMillis" type="string" required={false}>
          Processing time in milliseconds for Delivery events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="deliveryDelayType" type="string" required={false}>
          Delay type for DeliveryDelay events
        </NestedParam>

        <NestedParam parentKey="emailEvents.details" childKey="complaintFeedbackType" type="string" required={false}>
          Feedback type for Complaint events
        </NestedParam>
      </Expandable>
    </NestedParam>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash title="cURL" theme={"system"}
  curl --request POST \
    --url https://api.turnkey.com/public/v1/query/list_email_events \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --header "X-Stamp: <string> (see Authorizations)" \
    --data '{
      "organizationId": "<string>",
      "email": "<string>",
      "eventType": "<string>",
      "paginationOptions": {
          "limit": "<string>",
          "before": "<string>",
          "after": "<string>"
      }
  }'
  ```

  ```javascript title="JavaScript" theme={"system"}
  import { Turnkey } from "@turnkey/sdk-server";

  const turnkeyClient = new Turnkey({
    apiBaseUrl: "https://api.turnkey.com",
    apiPublicKey: process.env.API_PUBLIC_KEY!,
    apiPrivateKey: process.env.API_PRIVATE_KEY!,
    defaultOrganizationId: process.env.ORGANIZATION_ID!,
  });

  const response = await turnkeyClient.apiClient().listEmailEvents({
    organizationId: "<string> (Unique identifier for a given organization)",
    email: "<string> (Recipient email address to list email events for)",
    eventType: "<string> (Optional email event type to filter by. Examples include Send, Delivery, Bounce, and DeliveryDelay)",
    paginationOptions: { // paginationOptions field,
      limit: "<string> (A limit of the number of object to be returned, between 1 and 100. Defaults to 10.)",
      before: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects before this ID.)",
      after: "<string> (A pagination cursor. This is an object ID that enables you to fetch all objects after this ID.)",
    }
  });
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"system"}
  {
    "emailEvents": [
      {
        "id": "<string>",
        "organizationId": "<string>",
        "messageId": "<string>",
        "eventType": "<string>",
        "fromAddress": "<string>",
        "toAddress": "<string>",
        "senderTenant": "<string>",
        "timestamp": "<string>",
        "createdAt": "<string>",
        "details": {
          "bounceType": "<string>",
          "bounceSubType": "<string>",
          "diagnosticCode": "<string>",
          "deliverySmtpResponse": "<string>",
          "deliveryProcessingTimeMillis": "<string>",
          "deliveryDelayType": "<string>",
          "complaintFeedbackType": "<string>"
        }
      }
    ]
  }
  ```
</ResponseExample>