provider Campaigns API GET /campaigns
@utdk/sendgrid /campaigns
Retrieve all Campaigns
**This endpoint allows you to retrieve a list of all of your campaigns.** Returns campaigns in reverse order they were created (newest first). Returns an empty array if no campaigns exist.
limit query
The number of results you would like to receive at a time.
integer
offset query
The index of the first campaign to return, where 0 is the first campaign.
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getCampaigns
GET/campaigns
**This endpoint allows you to retrieve a list of all of your campaigns.** Returns campaigns in reverse order they were created (newest first). Returns an empty array if no campaigns exist.

The number of results you would like to receive at a time.

The index of the first campaign to return, where 0 is the first campaign.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getCampaigns({
  "limit": 10,
  "offset": 0,
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})