# GET /api/twilio/email-log/by-correlation/{correlationId}

Email Log: gets the full event history for one outbound message by its correlation id.

One outbound email produces several rows over its lifecycle (e.g. gateway-sent, then the
SendGrid delivery/open/bounce events), all sharing one correlation id. This returns every
such row ordered by timestamp ascending, giving the chronological delivery trail for that
message. The tenant and merchant ids must match the message's owning scope.

**Operation ID:** `emailLogGetByCorrelationId`

## Authorization

Requires: Twilio.EmailLog.View, merchant scope.

Required permissions:
- `Twilio.EmailLog.View`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| correlationId | path | yes | string(uuid) | Correlation id that ties together all events for one outbound message. |
| tenantId | query | no | string(uuid) | Tenant id that scopes the lookup. |
| merchantId | query | no | string(uuid) | Merchant id that scopes the lookup. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `application/json`

Schema type: `array<EmailLogDto>`

Item properties:
- `id` (string(uuid))
- `eventType` (string)
- `email` (string)
- `recipients` (string): Every visible recipient of an outbound message, semicolon-separated: the To addresses, then the  CC addresses. Present on the gateway's send row only, and absent on rows written before it was  recorded. BCC recipients are never listed.
- `fromEmail` (string)
- `replyToEmail` (string)
- `subject` (string)
- `timestamp` (string(date-time))
- `internalEventId` (string)
- `internalMessageId` (string)
- `messageId` (string)
- `correlationId` (string(uuid))
- `kind` (string): What kind of message the row belongs to, for example `Receipt`, `Invoice` or  `SecurityAlert`. Absent when the message declared no kind, and on rows recorded before  kinds were recorded.
- `bypassedSuppression` (boolean): `true` when the message was sent past the bounce, spam-report and global unsubscribe  suppression lists, which applies only to account-critical kinds such as `PasswordReset`  and `SecurityAlert`. Present only on the gateway's send row for a message the mail  provider accepted; absent on every other row, on a failed send, and on rows recorded before  the bypass existed.
- `isSenderDomainAuthenticated` (boolean)
- `scope` (EmailLogScopeDto): Read-only projection of the gateway scope under which an email row was recorded. Mirrors  the domain `Scope` value object; `Empty` / `null`  sentinels carry the same meaning (system-scoped or host-scoped).
- `uniqueArguments` (object)

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/twilio/email-log/by-correlation/{correlationId}" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/twilio/email-log/by-correlation/{correlationId}' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, MessagingApi } from '@winkpg/winkpg-api';

const api = new MessagingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.emailLogGetByCorrelationId("3fa85f64-5717-4562-b3fc-2c963f66afa6");
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/twilio/email-log/by-correlation/{correlationId}', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new MessagingApi(config);
var result = await api.EmailLogGetByCorrelationIdAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"));
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/twilio/email-log/by-correlation/{correlationId}");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.MessagingApi(client)
    result = api.email_log_get_by_correlation_id("3fa85f64-5717-4562-b3fc-2c963f66afa6")
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/twilio/email-log/by-correlation/{correlationId}",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.