Retrieve contact list membership information for a contact

get

/api/REST/2.0/data/contact/{id}/membership

Retrieves a list of contact lists that a contact is a member of.

Request

Supported Media Types
Path Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ContactList
Type: object
Title: ContactList
Show Source
Nested Schema : membershipAdditions
Type: array
The number of contact membership additions in the contact list.
Show Source
Nested Schema : membershipDeletions
Type: array
The number of contact membership deletions in the contact list.
Show Source
Nested Schema : permissions
Type: array
The permissions for the contact list granted to your current instance. This is a read-only property.
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve a list of the contact lists that a contact is a member of, when the contact id = 1:


GET /api/REST/2.0/data/contact/1/membership
			

Response:


[  
   {  
      "type":"ContactList",
      "id":"44",
      "name":"Summer 2016 Event Registrants"
   },
   {  
      "type":"ContactList",
      "id":"53",
      "name":"Poutine Contest Attendees"
   },
   {  
      "type":"ContactList",
      "id":"55",
      "name":"Summer 2016 Hotdog Eating Competition Winners"
   },
   {  
      "type":"ContactList",
      "id":"57",
      "name":"Summer 2016 CNE Attendees"
   },
   {  
      "type":"ContactList",
      "id":"116",
      "name":"Soft Bouncebacks"
   }
]
			
Back to Top