REST API for Oracle Eloqua Marketing Cloud Service

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

application/json

Path Parameters

id(required): integer

Id of the contact to retrieve.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : ContactList

Type: object

Title: ContactList

Show Source

count: string

Read Only: true

The number of contacts in the contact list. This is a read-only property.
createdAt: string

Read Only: true

The date and time the contact segment was created, expressed in Unix time.
createdBy: string

Read Only: true

The login id of the user who created the contact list.
currentStatus: string

The contact list's current status. This is a read-only property.
dataLookupId: string

The contact list's data lookup Id. This is a read-only property.
depth: string

Read Only: true

Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
description: string

The description of the contact list.
folderId: string

Read Only: true

The folder id of the folder which contains the contact list.
id: string

Read Only: true

Id of the contact list.
membershipAdditions: array membershipAdditions

The number of contact membership additions in the contact list.
membershipDeletions: array membershipDeletions

The number of contact membership deletions in the contact list.
name: string

The contact list's name.
permissions: array permissions

The permissions for the contact list granted to your current instance. This is a read-only property.
scheduledFor: string

Read Only: true

The date the contact list is scheduled.
scope: string

The contact list's scope: either local or global.
sourceTemplateId: string

Id of the template used to create the contact list.
type: string

The asset's type in Eloqua. This is a read-only property.
updatedAt: string

Read Only: true

Unix timestamp for the date and time the contact list was last updated.
updatedBy: string

Read Only: true

The login id of the user that last updated the contact list.

{
    "title":"ContactList",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the contact list."
        },
        "currentStatus":{
            "type":"string",
            "description":"The contact list's current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"The contact list's name."
        },
        "description":{
            "type":"string",
            "description":"The description of the contact list."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the contact list granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the contact list."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the contact list."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the contact list."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the contact segment was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the contact list."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the contact list was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the contact list is scheduled."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "scope":{
            "type":"string",
            "description":"The contact list's scope: either local or global."
        },
        "count":{
            "type":"string",
            "readOnly":true,
            "description":"The number of contacts in the contact list. This is a read-only property."
        },
        "membershipAdditions":{
            "type":"array",
            "description":"The number of contact membership additions in the contact list.",
            "items":{
                "type":"string"
            }
        },
        "membershipDeletions":{
            "type":"array",
            "description":"The number of contact membership deletions in the contact list.",
            "items":{
                "type":"string"
            }
        },
        "dataLookupId":{
            "type":"string",
            "description":"The contact list's data lookup Id. This is a read-only property."
        }
    }
}

Nested Schema : membershipAdditions

Type: array

The number of contact membership additions in the contact list.

Show Source

Array of: string

{
    "type":"array",
    "description":"The number of contact membership additions in the contact list.",
    "items":{
        "type":"string"
    }
}

Nested Schema : membershipDeletions

Type: array

The number of contact membership deletions in the contact list.

Show Source

Array of: string

{
    "type":"array",
    "description":"The number of contact membership deletions in the contact list.",
    "items":{
        "type":"string"
    }
}

Nested Schema : permissions

Type: array

The permissions for the contact list granted to your current instance. This is a read-only property.

Show Source

Array of: string

{
    "type":"array",
    "description":"The permissions for the contact list granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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.

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"
   }
]