Lists email-log 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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
MaxResultCount
required |
query | integer (int32) | Maximum rows per page. The app service caps this 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. |
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 PhoeniXGate.Twilio.EmailLog.EmailLogDto.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`). |
CorrelationId
required |
query | string (uuid) | Optional correlation id (single outbound message lifecycle). |
MessageId
required |
query | string | Optional SendGrid message id (cross-partition lookup). |
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 app service substitutes the operating-context merchant. Reseller-tree filtering ("see every merchant in my reseller tree") is intentionally not supported on this surface yet — the cross-module merchant lookup it requires is a follow-on capability. |
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.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.