On this page

Get Single Send by ID

API Overview

A Single Send is a one-time, non-automated email message delivered to a list or segment of your audience. A Single Send may be sent immediately or scheduled for future delivery.

Single Sends can serve many use cases, including promotional offers, engagement campaigns, newsletters, announcements, legal notices, or policy updates.

The Single Sends API allows you to create, retrieve, update, delete, schedule, and deliver your Single Sends. There are also endpoints for searching and statistics to help you maintain and alter your Single Sends as you learn more and further develop your campaigns.

The Single Sends API changed on May 6, 2020. Please check the SendGrid Knowledge Center for updates and instructions here: https://sendgrid.com/docs/for-developers/sending-email/single-sends-2020-update/

Operation overview

GET/v3/marketing/singlesends/{id}

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

This endpoint allows you to retrieve details about one Single Send using a Single Send ID.

You can retrieve all of your Single Sends by making a GET request to the /marketing/singlesends endpoint.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

idstringrequired

Responses

200404500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idstring<uuid>

The unique ID for the Single Send.

namestring

The name of the Single Send.

Min length: 1Max length: 100

statusenum<string>

The current status of the Single Send. The status may be draft, scheduled, or triggered.

Possible values:

draftscheduledtriggered

categoriesarray[string]

The categories associated with this Single Send.

send_atstring<date-time> or null

An ISO 8601 formatted date-time when the Single Send is set to be sent. Please note that any send_at property value will have no effect while the Single Send status is draft. You must update the Single Send with the Schedule Single Send endpoint or SendGrid application UI to schedule it.

send_toobject

Show child properties for send_to

updated_atstring<date-time>

the ISO 8601 time at which the Single Send was last updated.

created_atstring<date-time>

the ISO 8601 time at which the Single Send was created.

email_configobject

Show child properties for email_config

warningsarray[object]

Show child properties for warnings

Get Single Send by ID

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const id = "ZGkrHSypTsudrGkmdpJJ";
5
6const request = {
7  url: `/v3/marketing/singlesends/${id}`,
8  method: 'GET',
9  
10}
11
12client.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  });