List Membership Object

A list is a group of prospects that you can use to send list emails or to feed engagement programs. Use list membership resources to add and remove prospects to your static email lists, and to learn which prospects belong to which lists. Learn more about list membership in Salesforce Help.

The API to access the List Membership object follows the conventions described in Version 5 Overview.

OperationHTTP VerbURL FormatAbility Requirements
CreatePOSThttps://pi.pardot.com/api/v5/objects/list-memberships?<params>Marketing > Segmentation > Create AND Prospect > Prospects > Create ability
ReadGEThttps://pi.pardot.com/api/v5/objects/list-memberships/<id>?<params>Marketing > Segmentation > View AND Prospect > Prospects > View ability
UpdatePATCHhttps://pi.pardot.com/api/v5/objects/list-memberships/<id>?<params>Marketing > Segmentation > Create AND Prospect > Prospects > Create ability
QueryGEThttps://pi.pardot.com/api/v5/objects/list-memberships?<params>Marketing > Segmentation > View AND Prospect > Prospects > View ability
DeleteDELETEhttps://pi.pardot.com/api/v5/objects/list-memberships/<id>Marketing > Segmentation > Delete AND Prospect > Prospects > Delete ability

Read-Only Fields

FieldTypeDescription
idIntegerPardot ID for this list membership.
createdAtDateTimeThe time that this list membership was created. Reported in API user's preferred timezone.
updatedAtDateTimeThe time that this list membership was last updated. Reported in API user's timezone.
createdByIdIntegerID of the user who created this list membership.
updatedByIdIntegerID of the user who last updated this list membership.
isDeletedBooleanWhen true, the list membership is in the Pardot recycle bin.
prospectProspectProspect object representing the prospect associated with the list membership. See documentation for Prospect for fields.
createdByUserUser object representing the user who created this object. See documentation for User for fields.
updatedByUserUser object representing the user who last updated this object. See documentation for User for fields.
listListList object representing the list associated with the list membership. See documentation for List for fields.

Optional Editable Fields

FieldTypeDescription
optedOutBooleanWhen true, the prospect is unsubscribed from receiving emails from this list.
listIdIntegerPardot ID of the list for this membership
prospectIDIntegerPardot ID of the prospect for this membership

Create a list membership following the conventions described in the Version 5 Overview.

Example Request

Example Response

Retrieve a single list membership following the conventions described in the Version 5 Overview.

Example Request

Example Response

Updating a list membership follows the conventions described in Version 5 Overview.

Example Request

Example Response

Deleting a list membership follows the conventions described in Version 5 Overview.

Example Request

Example Response

204 No Content

Retrieve a collection of list memberships following the conventions described in the Version 5 Overview.

Sortable Fields

  • id
  • createdAt
  • updatedAt
  • listId

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

ParameterDescription
idReturns any list membership where ID is equal to the given integer value.
idGreaterThanReturns any list membership where ID is greater than the specified value, non-inclusive.
idGreaterThanOrEqualToReturns any list membership where ID is greater than or equal to the specified value.
idLessThanReturns any list membership where ID is less than the specified value, non-inclusive.
idLessThanOrEqualToReturns any list membership where ID is less than or equal to the specified value.
createdAtReturns any list membership where CreatedAt is equal to the given datetime value.
createdAtAfterReturns any list membership where CreatedAt is after the given datetime value, non-inclusive.
createdAtAfterOrEqualToReturns any list membership where CreatedAt is after or equal to the given datetime value.
createdAtBeforeReturns any list membership where CreatedAt is before the given datetime value, non-inclusive.
createdAtBeforeOrEqualToReturns any list membership where CreatedAt is before or equal to the given datetime value.
updatedAtReturns any list membership where UpdatedAt is equal to the given datetime value.
updatedAtAfterReturns any list membership where UpdatedAt is after the given datetime value, non-inclusive.
updatedAtAfterOrEqualToReturns any list membership where UpdatedAt is after or equal to the given datetime value.
updatedAtBeforeReturns any list membership where UpdatedAt is before the given datetime value, non-inclusive.
updatedAtBeforeOrEqualToReturns any list membership where UpdatedAt is before or equal to the given datetime value.
listIdReturns any list membership where listId is equal to the given integer value.
listIdGreaterThanReturns any list membership where listId is greater than the specified value, non-inclusive.
listIdGreaterThanOrEqualToReturns any list membership where listId is greater than or equal to the specified value.
listIdLessThanReturns any list membership where listId is less than the specified value, non-inclusive.
listIdLessThanOrEqualToReturns any list membership where listId is less than or equal to the specified value.
prospectIdReturns any list membership where prospectId is equal to the given integer value.
deletedDetermines whether to return deleted records. The value can be false (default), true, or all.

Example Request

Example Response