API Reference

Getting Started

How to send an email using API

Personalizing your emails

Migration APIs

Sendgrid Migration API

Email API

Domain API

Sending Domain v2.1

Fetch DNS Records

Check Domain Status

Fetch email activity

Download email activity

Tags API

Tags/stats/sums

Suppression API

For Recipient Email Address

For Recipient Domain

Subaccount API

Create Subaccount

List all Subaccounts

Enable/disable a subaccount

Delete a subaccount

Update the registered email address

Update password

Manage the credit allocation mode

Fetch the credit stats of a subaccount

Manage recurring credit allocation

Add/Subtract credits for a subaccount

Webhooks

Overview

Supported events

Examples to receive the response from webhooks

GDPR API

Request to export user data

Request to delete user data

Get status of the request by Request Id

Cancel the request by Request ID

Get status of the request by Tracking ID

Cancel the request by tracking ID

FAQ's

What is attribute?

What is X-TAGS?

What is X-APIHEADER?

Questions? Problems?

Powered by Stoplight

get

/logs

This endpoint allows you to retrieve the email transaction logs.

This includes following events:

Processed
Sent
Bounce (Hardbounce and Softbounce)
Dropped
Invalid
Opened
Clicked
Unsubscribe
Abuse

Please note - For a given set of parameters, you are only allowed to retrieve 1 million records out of total records generated. It is advisable to narrow down the range of the query to keep the record count limited to 1 million.

Request Parameters

10 Query Parameters

1 Header

Responses

1 Example

Schema

object

data

object

status

string

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

1 variable not set

host