Skip to contentSkip to navigationSkip to topbar
On this page

Retrieve all recipients on a List

API Overview

api-overview page anchor
(warning)

Legacy Marketing Campaigns

You are viewing the Legacy Marketing Campaigns API reference. For guidance migrating to the current version of Marketing Campaigns, see Migrating from Legacy Marketing Campaigns

(information)

Info

For the most up-to-date information on SendGrid's Contact Lists API, please visit the new Marketing Campaigns Lists API.

The Lists API allows you to manage your Marketing Campaigns contact lists. You can create, retrieve, update, and delete lists, as well as add and remove contacts from lists.

Operation overview

operation-overview page anchor

GET/v3/contactdb/lists/{list_id}/recipients

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

This endpoint allows you to retrieve all recipients on the list with the given ID.

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
list_idinteger
required

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

Query string

query-string page anchor
Property nameTypeRequiredDescription
pageinteger

Optional

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

page_sizeinteger

Optional

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

Responses

responses page anchor
200400404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
recipientsarray[ContactDB: Recipient]

Optional

Retrieve all recipients on a ListLink to code sample: Retrieve all recipients on a List
1
const client = require("@sendgrid/client");

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

3


4
const list_id = 42;

5


6
const request = {

7
  url: `/v3/contactdb/lists/${list_id}/recipients`,

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
  });