provider Contacts API - Lists GET /contactdb/lists/{list_id}/recipients
@utdk/sendgrid /contactdb/lists/{list_id}/recipients
Retrieve all recipients on a List
**This endpoint allows you to retrieve all recipients on the list with the given ID.**
list_id path required
The id of the list of recipients you want to retrieve.
integer
page query
Page index of first recipient 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
list_id query required
The ID of the list whose recipients you are requesting.
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.

getContactdbListsListIdRecipients
GET/contactdb/lists/{list_id}/recipients
**This endpoint allows you to retrieve all recipients on the list with the given ID.**

Parameters

required

The id of the list of recipients you want to retrieve.

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

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

required

The ID of the list whose recipients you are requesting.

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