Retrieve a list of contact lists

get

/api/REST/1.0/assets/contact/lists

Retrieves all contact lists that match the criteria specified by the request parameters.

Request

Supported Media Types
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • 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 minimal by default.
  • Unix timestamp for the date and time the contact list was last updated.
  • Specifies the field by which list results are ordered.
  • Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultList
Type: object
Title: QueryResultList
Show Source
Nested Schema : elements
Type: array
Array of contact list fields.
Show Source
Nested 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

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 the first 2 contact lists in your database:


GET /api/REST/1.0/assets/contact/lists?count=2
			

Response:


{
    "elements":[
        {
            "type":"ContactList",
            "id":"51",
            "createdAt":"1306510214",
            "depth":"minimal",
            "description":"",
            "folderId":"360",
            "name":"Example Contact list",
            "permissions":"fullControl",
            "updatedAt":"1306510214"
        },
        {
            "type":"ContactList",
            "id":"21",
            "createdAt":"1144185072",
            "depth":"minimal",
            "description":"",
            "folderId":"229",
            "name":"Example list 2",
            "permissions":"fullControl",
            "updatedAt":"1171989920"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":25
}
			
Back to Top