Email Log: lists rows for the caller's scope, newest first, with cursor-based paging.

GET /api/twilio/email-log deprecated

Requires: Twilio.EmailLog.View, merchant scope.

Returns a page of outbound-email and SendGrid event records. All query filters (recipient email, event types, correlation id, message id, timestamp range) are optional and combined with AND. Tenant and merchant scoping is enforced server-side from the caller's operating context: merchant-scoped users see only their own merchant, while a caller holding `EmailLog.ViewAllMerchants` may target a specific merchant via `MerchantId` or leave the scope open. Paging is keyset / cursor-based, not skip/take. Pass `NextContinuationToken` from the previous response back as `ContinuationToken` to fetch the next page; a `null` token in the response means there are no further pages. Sorting supports `Timestamp ASC` / `Timestamp DESC` only and defaults to descending.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/twilio/email-log" \
  -H "api-key: {{API_KEY}}"

PowerShell

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.emailLogGetList();

TypeScript (raw HTTP)

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

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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.EmailLogGetListAsync();

C# (raw HTTP)

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

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

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

pip install winkpg-api

Python (SDK)

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_list()

pip install requests

Python (raw HTTP)

import requests

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

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

Parameters

Name	In	Type	Description
`MaxResultCount` required	query	integer (int32)	Maximum rows per page, capped at 100.
`ContinuationToken` required	query	string	Opaque cursor returned by a prior call. `null` for the first page.
`IncludeDeleted` required	query	boolean	Disables the soft-delete filter. Honoured only for callers with the relevant permission.
`IncludeInactive` required	query	boolean	Disables the IsActive filter. Honoured only for callers with the relevant permission.
`IncludeApproxTotalCount` required	query	boolean	Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before.
`Sorting` required	query	string	Sort direction. Only `Timestamp ASC` and `Timestamp DESC` are supported: the cursor encodes (Timestamp, Id) for stable paging, so multi-field sorts would require a richer cursor than this surface needs. Anything else falls back to `Timestamp DESC`.
`Filter` required	query	string	Optional substring match on `email`.
`Email` required	query	string	Optional exact-match recipient email.
`EventTypes` required	query	array of string	Optional event-type include list (e.g. `Delivered`, `GatewaySent`).
`Kinds` required	query	array of string	Optional message-kind include list (for example `Receipt`, `Invoice`). A row whose message declared no kind never matches a kind filter.
`CorrelationId` required	query	string (uuid)	Optional correlation id (single outbound message lifecycle).
`MessageId` required	query	string	Optional SendGrid message id.
`MinTimestamp` required	query	string (date-time)	Inclusive lower-bound timestamp filter.
`MaxTimestamp` required	query	string (date-time)	Exclusive upper-bound timestamp filter.
`MerchantId` required	query	string (uuid)	Caller-requested merchant scope. Honoured only when the caller has the `EmailLog.ViewAllMerchants` permission; otherwise the caller's own merchant is used. Filtering by reseller tree ("see every merchant in my reseller tree") is not supported.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description

This request body has no documented fields.