provider Contacts API - Recipients GET /contactdb/recipients/{recipient_id}/lists
@utdk/sendgrid /contactdb/recipients/{recipient_id}/lists
Retrieve the lists that a recipient is on
**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.
recipient_id path required
The ID of the recipient for whom you are retrieving lists.
string
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.

getContactdbRecipientsRecipientIdLists
GET/contactdb/recipients/{recipient_id}/lists
**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.

Parameters

required

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

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