Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
Page tools
On this page
Looking for more inspiration?Visit the

Retrieve a single campaign

API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

This covers the obsolete Legacy Marketing Campaigns API.

(information)

Info

For the most up-to-date information on the Sender Identities API, please visit the new Marketing Campaigns Single Sends API.

The Campaigns API allows you to create and manage marketing campaigns. You can create campaigns, manage campaign content, and schedule campaigns to be sent at a later time.

Operation overview

operation-overview page anchor

GET/v3/campaigns/{campaign_id}

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

This endpoint allows you to retrieve a specific campaign.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstring

Optional

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

Path parameters

path-parameters page anchor
Property nameTypeRequiredDescription
campaign_idinteger
required

The id of the campaign you would like to retrieve.

Responses

responses page anchor
200401404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
categoriesarray[string]

Optional

custom_unsubscribe_urlstring

Optional

html_contentstring

Optional

idinteger

Optional

ip_poolstring

Optional

list_idsarray[integer]

Optional

plain_contentstring

Optional

segment_idsarray[integer]

Optional

sender_idinteger

Optional

statusstring

Optional

subjectstring

Optional

suppression_group_idinteger

Optional

titlestring

Optional

Retrieve a single campaignLink to code sample: Retrieve a single campaign
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const campaign_id = 42;

5


6
const request = {

7
  url: `/v3/campaigns/${campaign_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
  });