Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Retrieve a single 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}

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

This endpoint allows you to retrieve a single recipient list.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
on-behalf-ofstringOptional

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_idintegerrequired

Responses

responses page anchor
200400401404
SchemaExample
Property nameTypeRequiredDescriptionChild properties
idinteger

The reference ID of your list.

namestring

The name of your list. Must be unique against all other list and segment names.

recipient_countinteger

The count of recipients currently in the list.

Retrieve a single listLink to code sample: Retrieve a single list
1
const client = require('@sendgrid/client');

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

3


4
const list_id = 4900;

5


6
const request = {

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

8
  method: 'GET',

9
  

10
}

11


12
client.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
  });