Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Get Single Sends Search



API Overview

api-overview page anchor

A Single Send is a one-time nonautomated 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/


POST/v3/marketing/singlesends/search

Base url: https://api.sendgrid.com

This endpoint allows you to search for Single Sends based on specified criteria.

You can search for Single Sends by passing a combination of values using the name, status, and categories request body fields.

For example, if you want to search for all Single Sends that are "drafts" or "scheduled" and also associated with the category "shoes," your request body may look like the example below.


_10
{
_10
"status": [
_10
"draft",
_10
"scheduled"
_10
],
_10
"categories": [
_10
"shoes"
_10
],
_10
}


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
page_sizeinteger

page_tokenstring
Schema
namestring

leading and trailing wildcard search on name of the Single Send

Min length: 1Max length: 100

statusarray[enum<string>]

current status of the Single Send

Possible values:
draftscheduledtriggered

categoriesarray[string]

categories to associate with this Single Send, match any single send that has at least one of the categories

200404
SchemaExample
resultarray[object]

_metadataobject
get-single-sends-search page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_18
const client = require('@sendgrid/client');
_18
client.setApiKey(process.env.SENDGRID_API_KEY);
_18
_18
_18
const request = {
_18
url: `/v3/marketing/singlesends/search`,
_18
method: 'POST',
_18
_18
}
_18
_18
client.request(request)
_18
.then(([response, body]) => {
_18
console.log(response.statusCode);
_18
console.log(response.body);
_18
})
_18
.catch(error => {
_18
console.error(error);
_18
});


Rate this page: