Skip to content Skip to navigation Skip to topbar

Retrieve the lists that a recipient is on

API Overview

(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 the Contacts API, please visit the new Marketing Campaigns Contacts API.

The Contacts Recipients API allows you to manage your recipients. You can add, retrieve, update, and delete recipients, as well as get a count of all recipients and all billable recipients.

Operation overview

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

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve the lists that a given recipient belongs to.

Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.

Operation details

Authentication

API Key

Headers

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

Property nameTypeRequiredDescription

recipient_idstringrequired

The ID of the recipient for whom you are retrieving lists.

Responses

200400401404

SchemaExample

Property nameTypeRequiredDescriptionChild properties

listsarray[object]

Show child properties for lists

Returned if recipient_id is not valid

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Returned if a record for the recipient id does not exist

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

Show child properties for errors

idstring

When applicable, this property value will be an error ID.

Retrieve the lists that a recipient is on

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const recipient_id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19const request = {
_19  url: `/v3/contactdb/recipients/${recipient_id}/lists`,
_19  method: 'GET',
_19  
_19}
_19
_19client.request(request)
_19  .then(([response, body]) => {
_19    console.log(response.statusCode);
_19    console.log(response.body);
_19  })
_19  .catch(error => {
_19    console.error(error);
_19  });