Skip to contentSkip to navigationSkip to topbar
On this page

Filter messages by message ID



API Overview

api-overview page anchor

You must purchase additional email activity history(link takes you to an external page) to gain access to the Email Activity Feed API.

The Email Activity API allows you to query all of your stored messages, query individual messages, and download a CSV with data about the stored messages.

Once retrieved, you can inspect the data associated with your messages to better understand your mail send. For example, you may retrieve all bounced messages or all messages with the same subject line and search for commonalities among them.

See "Getting Started with the Email Activity Feed API" for help building queries and working with the API.

You can also work with email activity in the Activity section of the Twilio SendGrid App(link takes you to an external page).


GET/v3/messages/{msg_id}

Base url: https://api.sendgrid.com (The Twilio SendGrid v3 API)

Get all of the details about the specified message.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
msgIdstring
required

The ID of the message you are requesting details for.

200400404429
SchemaExample
Property nameTypeRequiredDescriptionChild properties
fromEmailstring<email>

Optional

The 'From' email address used to deliver the message. This address should be a verified sender in your Twilio SendGrid account.

Default: test0@example.com

msgIdstring

Optional

A unique ID assigned to the message. This ID can be used to retrieve activity data for the specific message.


subjectstring

Optional

The email's subject line.


toEmailstring<email>

Optional

The intended recipient's email address.


statusenum<string>

Optional

The message's status.

Possible values:
processeddeliverednot_delivered

templateIdstring

Optional

The ID associated with a Twilio SendGrid email template used to format the message.


asmGroupIdinteger

Optional

The unsubscribe group associated with this email.

Minimum: 1

teammatestring

Optional

Teammate's username

Pattern: ^$|^[A-Za-z0-9]+Min length: 0Max length: 64

apiKeyIdstring

Optional

The ID of the API Key used to authenticate the sending request for the message.

Pattern: ^[A-Za-z0-9]+Min length: 3Max length: 50

eventsarray[Event]

Optional

List of events related to email message


originatingIpstring<ipv4>

Optional

This is the IP of the user who sent the message.


categoriesarray[string]

Optional

Categories users associated to the message


uniqueArgsstring

Optional

JSON hash of key-value pairs associated with the message.

Default: Null

outboundIpstring<ipv4>

Optional

IP used to send to the remote Mail Transfer Agent.


outboundIpTypeenum<string>

Optional

Whether or not the outbound IP is dedicated vs shared

Possible values:
dedicatedshared
Filter messages by message IDLink to code sample: Filter messages by message ID
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const msg_id = "msg_id";
5
6
const request = {
7
url: `/v3/messages/${msg_id}`,
8
method: "GET",
9
};
10
11
client
12
.request(request)
13
.then(([response, body]) => {
14
console.log(response.statusCode);
15
console.log(response.body);
16
})
17
.catch((error) => {
18
console.error(error);
19
});