Retrieve the lists that a recipient is on

Contacts API - Recipients

Elements that can be shared among more than one endpoint definition.

Retrieve the lists that a recipient is on

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.

Authentication

API Key

Headers

Authorization

string

default: Bearer <<YOUR_API_KEY_HERE>>

required

on-behalf-of

string

default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Path Parameters

recipient_id

string

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

required

Responses

object

lists

array[object]

integer

The reference ID of your list.

name

string

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

recipient_count

integer

The count of recipients currently in the list.

object

errors

array[object]

message

string

the error message

field

string

the field that generated the error

help

object

helper text or docs for troubleshooting

string

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

object

errors

array[object]

message

string

the error message

field

string

the field that generated the error

help

object

helper text or docs for troubleshooting

string

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

object

errors

array[object]

message

string

the error message

field

string

the field that generated the error

help

object

helper text or docs for troubleshooting

string

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.