Retrieve contact information
post
/api/rest/2.0/data/contacts
Retrieves contact information for up to 200 contacts, searched by contact id. Use the
depth
parameter when making the request to specify the contact information returned in the response.Request
Supported Media Types
- application/json
Header Parameters
-
X-HTTP-Method-Override(required): string(string)
The request header
X-HTTP-Method-Override
must be set with valueSEARCH
.Default Value:SEARCH
The request body defines the details of the request.
Root Schema : EntitySearchByIds
Type:
object
Title:
Show Source
EntitySearchByIds
-
depth:
string
Read Only:
true
Level of detail returned by the request. The default will beminimal
. Learn more about the depth parameter. -
ids:
array ids
The ids to retrieve. Maximum of 200 ids per request. If the array contains duplicate ids, or exceeds the 200 limit, a 400 Bad Request will be returned.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : ids
Type:
array
The ids to retrieve. Maximum of 200 ids per request. If the array contains duplicate ids, or exceeds the 200 limit, a 400 Bad Request will be returned.
Show Source
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Contact
Type:
object
Title:
Show Source
Contact
-
accountId:
string
The account id in which the contact belongs. This is a read-only property.
-
accountName:
string
The account name in which the contact belongs.
-
address1:
string
The contact's first address.
-
address2:
string
The contact's second address.
-
address3:
string
The contact's third address.
-
bouncebackDate:
string
The contact's bounceback date.
-
businessPhone:
string
The contact's business phone number.
-
city:
string
The contact's city.
-
country:
string
The contact's country.
-
createdAt:
string
Read Only:
true
The date and time the contact was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the contact. -
createdByName:
string
The name of the user who created the contact.
-
currentStatus:
string
The contact's current status.
-
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.
-
emailAddress:
string
The contact's email address.
-
emailFormatPreference:
string
The contact's email format preference.
-
fax:
string
The contact's fax number.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the contactFields associated with a given contact. -
firstName:
string
The contact's first name.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the contact. -
id:
string
Read Only:
true
Id of the contact. This is a read-only property. -
isBounceback:
string
Whether or not the contact has any associated bouncebacks.
-
isSmsSubscribed:
string
Whether or not the contact is subscribed for SMS.
-
isSubscribed:
string
Whether or not the contact is subscribed.
-
lastName:
string
The contact's last name.
-
mobilePhone:
string
The contact's mobile phone number.
-
name:
string
The name of the contact.
-
nextEvaluationTime:
string
The time when the contact is scheduled to be processed. This is a read-only property. This property can only be retrieved when a
stepid
is provided. -
permissions:
array permissions
The permissions for the contact granted to your current instance. This is a read-only property.
-
postalCode:
string
The contact's postal code.
-
province:
string
The contact's province.
-
salesPerson:
string
The contact's account representative.
-
scheduledFor:
string
Read Only:
true
The date the contact is scheduled. -
sourceTemplateId:
string
Id of the template used to create the asset.
-
stepEntryTime:
string
The time the contact was added to a step. This is a read-only property. This property can only be retrieved when a
stepid
is provided. -
subscriptionDate:
string
The contact's subscription date.
-
title:
string
The contact's title.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
unsubscriptionDate:
string
The contact's unsubscription date.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the contact was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the contact. -
updatedByName:
string
The name of the user who last updated the contact.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the contactFields associated with a given contact.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : permissions
Type:
array
The permissions for the contact granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
name:
string
Name of the field value.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
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 2 contacts at minimal depth:
POST api/REST/2.0/data/contacts
X-HTTP-Method-Override: SEARCH
Content-Type: application/json
Request body:
{
"ids": [1, 2],
"depth": "minimal"
}
Response:
[
{
"type":"Contact",
"id":"1",
"createdAt":"1418667629",
"depth":"minimal",
"name":"api.user@test.oracle.com",
"updatedAt":"1466689992"
},
{
"type":"Contact",
"id":"2",
"createdAt":"1418673492",
"depth":"minimal",
"name":"api.user2@test.oracle.com",
"updatedAt":"1469552212"
}
]
Retrieve 2 contacts at partial depth:
POST api/REST/2.0/data/contacts
X-HTTP-Method-Override: SEARCH
Content-Type: application/json
Request body:
{
"ids": [1, 2],
"depth": "partial"
}
Response:
[
{
"type":"Contact",
"currentStatus":"Awaiting action",
"id":"1",
"createdAt":"1469932737",
"depth":"partial",
"name":"example.user@blackhole.oracle.com",
"updatedAt":"1469932737",
"accountName":"Example Account",
"address1":"3001 Bellevue Avenue",
"address2":"3002 S. Harris Street",
"address3":"3003 Woodrow Wilson Drive",
"businessPhone":"(239) 334-3602",
"city":"ABU DHABI",
"emailAddress":"example.user@blackhole.oracle.com",
"emailFormatPreference":"unspecified",
"fax":"(239) 656-7949",
"firstName":"John",
"isBounceback":"false",
"isSubscribed":"true",
"lastName":"Doe",
"mobilePhone":"(239) 461-7380",
"postalCode":"2217",
"salesPerson":"Salesperson_b105d00580",
"subscriptionDate":"1469932737",
"title":"CEO"
},
{
"type":"Contact",
"currentStatus":"Awaiting action",
"id":"2",
"createdAt":"1469932737",
"depth":"partial",
"name":"test.user@blackhole.oracle.com",
"updatedAt":"1469932737",
"accountName":"Testing Industries",
"address1":"3004 South Valdosta Road",
"address2":"3005 Lakes Blvd",
"address3":"3006 Us Highway 129 And Jackson Street",
"businessPhone":"(239) 461-3188",
"city":"Acapulco (de Ju??rez)",
"emailAddress":"test.user@blackhole.oracle.com",
"emailFormatPreference":"unspecified",
"fax":"(239) 995-2665",
"firstName":"Matt",
"isBounceback":"false",
"isSubscribed":"true",
"lastName":"Pascow",
"mobilePhone":"(239) 390-3232",
"postalCode":"2222",
"salesPerson":"Salesperson_1584307379",
"subscriptionDate":"1469932737",
"title":"CFO"
}
]
Retrieve 1 contact at complete depth:
POST api/REST/2.0/data/contacts
X-HTTP-Method-Override: SEARCH
Content-Type: application/json
Request body:
{
"ids": [1],
"depth": "complete"
}
Response:
[
{
"type": "Contact",
"currentStatus": "Awaiting action",
"id": "1",
"createdAt": "1469932737",
"depth": "complete",
"name": "example.user@blackhole.oracle.com",
"updatedAt": "1469932737",
"accountId": "1",
"accountName": "Example Account",
"address1": "3001 Bellevue Avenue",
"address2": "3002 S. Harris Street",
"address3": "3003 Woodrow Wilson Drive",
"businessPhone": "(239) 334-3602",
"city": "ABU DHABI",
"emailAddress": "example.user@blackhole.oracle.com",
"emailFormatPreference": "unspecified",
"fax": "(239) 656-7949",
"fieldValues": [
{
"type": "FieldValue",
"id": "100005",
"value": "EmailDisplayName_cb1e0969a8"
},
...
],
"firstName": "John",
"isBounceback": "false",
"isSubscribed": "true",
"lastName": "Doe",
"mobilePhone": "(239) 461-7380",
"postalCode": "2217",
"salesPerson": "Salesperson_b105d00580",
"subscriptionDate": "1469932737",
"title": "CEO"
}
]