Retrieve the lists that a recipient is on

v1.0.0

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.

Input

{
  "type": "object",
  "properties": {
    "on-behalf-of": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "lists": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "name",
          "recipient_count"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "description": "The reference ID of your list."
          },
          "name": {
            "type": "string",
            "description": "The name of your list. Must be unique against all other list and segment names."
          },
          "recipient_count": {
            "type": "integer",
            "description": "The count of recipients currently in the list."
          }
        }
      }
    }
  }
}