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
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tominimal
by default. -
lastUpdatedAt: integer
Unix timestamp for the date and time the contact list was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
page: integer
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.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultList
Type:
object
Title:
Show Source
QueryResultList
-
elements:
array elements
Array of contact list fields.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of contact list fields.
Show Source
-
Array of:
object ContactList
Title:
ContactList
Nested Schema : ContactList
Type:
object
Title:
Show Source
ContactList
-
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. This is a read-only property. -
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
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of 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:
string
The permissions for the contact list granted to your current instance. This is a read-only property.
-
scope:
string
The contact list's scope: either
local
orglobal
. -
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.
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.
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
}