provider Contacts API - Recipients GET /contactdb/recipients
@utdk/sendgrid /contactdb/recipients
Retrieve recipients
**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.
page query
Page index of first recipients to return (must be a positive integer)
integer
page_size query
Number of recipients to return at a time (must be a positive integer between 1 and 1000)
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.

getContactdbRecipients
GET/contactdb/recipients
**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.

Page index of first recipients to return (must be a positive integer)

Number of recipients to return at a time (must be a positive integer between 1 and 1000)

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.getContactdbRecipients({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})