provider Contacts API - Segments GET /contactdb/segments/{segment_id}/recipients
@utdk/sendgrid /contactdb/segments/{segment_id}/recipients
Retrieve recipients on a segment
**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**
segment_id path required
The ID of the segment from which you want to retrieve recipients.
integer
page query
integer
page_size query
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
getContactdbSegmentsSegmentIdRecipients
GET/contactdb/segments/{segment_id}/recipients
**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**

Parameters

required

The ID of the segment from which you want to retrieve recipients.

Configure credentials above to enable sending.

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

TypeScript

import sendgrid from '@utdk/sendgrid';

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