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.

Important: Request header 'X-HTTP-Method-Override' needs to be set with value 'SEARCH'.

Request parameters

Required

Name

Type

Description

Possible values
ids array The contact ids to retrieve. Maximum of 200 contact ids per request. If the array contains duplicate contact ids, or exceeds the 200 limit, a 400 Bad Request will be returned.  

Optional

Name

Type

Description

Possible values
depth

string

Level of detail returned by the request. The default will be minimal. Learn more about the depth parameter.

  • minmal
  • partial
  • complete

Response parameters

Name

Type

Description

Possible values

type

string

The type of asset in Eloqua.

Contact
id string The contact id of the contact.  
createdAt string The date and time the contact was created, expressed in Unix time.  
depth string The request's level of detail.
  • minmal
  • partial
  • complete

name

string

The name of the contact.

 
updatedAt string The date and time the contact was last updated, expressed in Unix time.  

Note: For a full list of parameters returned within the contact object see Retrieve a contact response parameters.

Example

Retrieve 3 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, 3],
    "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"
}, {
    "type": "Contact",
    "id": "3",
    "createdAt": "1420586365",
    "depth": "minimal",
    "name": "api.user3@test.oracle.com",
    "updatedAt": "1466689992"
}]

Retrieve 3 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, 3],
    "depth": "partial"
}

Response:

[
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "1",
    "createdAt": "1418667629",
    "depth": "partial",
    "name": "api.user@test.oracle.com",
    "updatedAt": "1466689992",
    "emailAddress": "api.user@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "firstName": "Test",
    "isBounceback": "false",
    "isSubscribed": "true",
    "lastName": "User",
    "subscriptionDate": "1418673391"
  },
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "2",
    "createdAt": "1418673492",
    "depth": "partial",
    "name": "api.user2@test.oracle.com",
    "updatedAt": "1469552212",
    "bouncebackDate": "1469552198",
    "emailAddress": "api.user2@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "firstName": "TEST",
    "isBounceback": "true",
    "isSubscribed": "true",
    "lastName": "USER",
    "subscriptionDate": "1418673492"
  },
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "3",
    "createdAt": "1420586365",
    "depth": "partial",
    "name": "api.user3@test.oracle.com",
    "updatedAt": "1466689992",
    "emailAddress": "api.user3@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "firstName": "Test",
    "isBounceback": "false",
    "isSubscribed": "true",
    "lastName": "User",
    "subscriptionDate": "1420586365"
  }
]

Retrieve 3 contacts at complete depth:

POST api/REST/2.0/data/contacts
X-HTTP-Method-Override: SEARCH
Content-Type: application/json

Request body:

{
    "ids": [1, 2, 3],
    "depth": "complete"
}

Response:

[
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "1",
    "createdAt": "1418667629",
    "depth": "complete",
    "name": "api.user@test.oracle.com",
    "updatedAt": "1466689992",
    "emailAddress": "api.user@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "fieldValues": [
      {
        "type": "FieldValue",
        "id": "100005"
      },
      {
        "type": "FieldValue",
        "id": "100017"
      },
      {
        "type": "FieldValue",
        "id": "100023"
      },
      {
        "type": "FieldValue",
        "id": "100024"
      },
      {
        "type": "FieldValue",
        "id": "100032",
        "value": "CDC13000000000001"
      },
      {
        "type": "FieldValue",
        "id": "100033"
      },
      {
        "type": "FieldValue",
        "id": "100034"
      },
      {
        "type": "FieldValue",
        "id": "100035"
      },
      {
        "type": "FieldValue",
        "id": "100036"
      },
      {
        "type": "FieldValue",
        "id": "100041"
      },
      {
        "type": "FieldValue",
        "id": "100043"
      },
      {
        "type": "FieldValue",
        "id": "100044"
      },
      {
        "type": "FieldValue",
        "id": "100045"
      },
      {
        "type": "FieldValue",
        "id": "100046"
      },
      {
        "type": "FieldValue",
        "id": "100047"
      },
      {
        "type": "FieldValue",
        "id": "100048"
      },
      {
        "type": "FieldValue",
        "id": "100049"
      },
      {
        "type": "FieldValue",
        "id": "100051"
      },
      {
        "type": "FieldValue",
        "id": "100065"
      },
      {
        "type": "FieldValue",
        "id": "100066"
      },
      {
        "type": "FieldValue",
        "id": "100068"
      },
      {
        "type": "FieldValue",
        "id": "100069"
      },
      {
        "type": "FieldValue",
        "id": "100072"
      },
      {
        "type": "FieldValue",
        "id": "100081"
      },
      {
        "type": "FieldValue",
        "id": "100171",
        "value": "test.oracle.com"
      },
      {
        "type": "FieldValue",
        "id": "100172",
        "value": "Test User1"
      },
      {
        "type": "FieldValue",
        "id": "100174"
      },
      {
        "type": "FieldValue",
        "id": "100175"
      },
      {
        "type": "FieldValue",
        "id": "100176"
      },
      {
        "type": "FieldValue",
        "id": "100177"
      },
      {
        "type": "FieldValue",
        "id": "100178"
      },
      {
        "type": "FieldValue",
        "id": "100179"
      },
      {
        "type": "FieldValue",
        "id": "100180"
      },
      {
        "type": "FieldValue",
        "id": "100181",
        "value": "da68a5a72dc49fa2001646dad425ba33"
      },
      {
        "type": "FieldValue",
        "id": "100182",
        "value": "84ee430a8f7b234085611386a79ee9ccc604103b85e3d2da94a109b3b34da98b"
      },
      {
        "type": "FieldValue",
        "id": "100183"
      },
      {
        "type": "FieldValue",
        "id": "100184"
      },
      {
        "type": "FieldValue",
        "id": "100185"
      },
      {
        "type": "FieldValue",
        "id": "100186"
      },
      {
        "type": "FieldValue",
        "id": "100187"
      },
      {
        "type": "FieldValue",
        "id": "100188",
        "value": "TestUser1L88888"
      }
    ],
    "firstName": "Test",
    "isBounceback": "false",
    "isSubscribed": "true",
    "lastName": "User",
    "subscriptionDate": "1418673391"
  },
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "2",
    "createdAt": "1418673492",
    "depth": "complete",
    "name": "api.user2@test.oracle.com",
    "updatedAt": "1469552212",
    "bouncebackDate": "1469552198",
    "emailAddress": "api.user2@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "fieldValues": [
      {
        "type": "FieldValue",
        "id": "100005"
      },
      {
        "type": "FieldValue",
        "id": "100017"
      },
      {
        "type": "FieldValue",
        "id": "100023"
      },
      {
        "type": "FieldValue",
        "id": "100024"
      },
      {
        "type": "FieldValue",
        "id": "100032",
        "value": "CDC13000000000002"
      },
      {
        "type": "FieldValue",
        "id": "100033"
      },
      {
        "type": "FieldValue",
        "id": "100034"
      },
      {
        "type": "FieldValue",
        "id": "100035"
      },
      {
        "type": "FieldValue",
        "id": "100036"
      },
      {
        "type": "FieldValue",
        "id": "100041"
      },
      {
        "type": "FieldValue",
        "id": "100043"
      },
      {
        "type": "FieldValue",
        "id": "100044"
      },
      {
        "type": "FieldValue",
        "id": "100045"
      },
      {
        "type": "FieldValue",
        "id": "100046"
      },
      {
        "type": "FieldValue",
        "id": "100047"
      },
      {
        "type": "FieldValue",
        "id": "100048"
      },
      {
        "type": "FieldValue",
        "id": "100049"
      },
      {
        "type": "FieldValue",
        "id": "100051"
      },
      {
        "type": "FieldValue",
        "id": "100065"
      },
      {
        "type": "FieldValue",
        "id": "100066"
      },
      {
        "type": "FieldValue",
        "id": "100068"
      },
      {
        "type": "FieldValue",
        "id": "100069"
      },
      {
        "type": "FieldValue",
        "id": "100072"
      },
      {
        "type": "FieldValue",
        "id": "100081"
      },
      {
        "type": "FieldValue",
        "id": "100171",
        "value": "oracle.com"
      },
      {
        "type": "FieldValue",
        "id": "100172",
        "value": "TEST USER C"
      },
      {
        "type": "FieldValue",
        "id": "100174"
      },
      {
        "type": "FieldValue",
        "id": "100175"
      },
      {
        "type": "FieldValue",
        "id": "100176"
      },
      {
        "type": "FieldValue",
        "id": "100177"
      },
      {
        "type": "FieldValue",
        "id": "100178"
      },
      {
        "type": "FieldValue",
        "id": "100179"
      },
      {
        "type": "FieldValue",
        "id": "100180"
      },
      {
        "type": "FieldValue",
        "id": "100181",
        "value": "1591dd1bbaccf044659695773522aff0"
      },
      {
        "type": "FieldValue",
        "id": "100182",
        "value": "181bd0a7d97ba1b9b7475089b97bb91ba9eb84f2b195ec32a50f8cf39fb973ad"
      },
      {
        "type": "FieldValue",
        "id": "100183"
      },
      {
        "type": "FieldValue",
        "id": "100184"
      },
      {
        "type": "FieldValue",
        "id": "100185"
      },
      {
        "type": "FieldValue",
        "id": "100186"
      },
      {
        "type": "FieldValue",
        "id": "100187"
      },
      {
        "type": "FieldValue",
        "id": "100188",
        "value": "TESTUSERCL8888L"
      }
    ],
    "firstName": "Test",
    "isBounceback": "true",
    "isSubscribed": "true",
    "lastName": "User",
    "subscriptionDate": "1418673492"
  },
  {
    "type": "Contact",
    "currentStatus": "Awaiting action",
    "id": "3",
    "createdAt": "1420586365",
    "depth": "complete",
    "name": "api.user3@test.oracle.com",
    "updatedAt": "1466689992",
    "emailAddress": "api.user3@test.oracle.com",
    "emailFormatPreference": "unspecified",
    "fieldValues": [
      {
        "type": "FieldValue",
        "id": "100005"
      },
      {
        "type": "FieldValue",
        "id": "100017"
      },
      {
        "type": "FieldValue",
        "id": "100023"
      },
      {
        "type": "FieldValue",
        "id": "100024"
      },
      {
        "type": "FieldValue",
        "id": "100032",
        "value": "CDC13000000000003"
      },
      {
        "type": "FieldValue",
        "id": "100033"
      },
      {
        "type": "FieldValue",
        "id": "100034"
      },
      {
        "type": "FieldValue",
        "id": "100035"
      },
      {
        "type": "FieldValue",
        "id": "100036"
      },
      {
        "type": "FieldValue",
        "id": "100041"
      },
      {
        "type": "FieldValue",
        "id": "100043"
      },
      {
        "type": "FieldValue",
        "id": "100044"
      },
      {
        "type": "FieldValue",
        "id": "100045"
      },
      {
        "type": "FieldValue",
        "id": "100046"
      },
      {
        "type": "FieldValue",
        "id": "100047"
      },
      {
        "type": "FieldValue",
        "id": "100048"
      },
      {
        "type": "FieldValue",
        "id": "100049"
      },
      {
        "type": "FieldValue",
        "id": "100051"
      },
      {
        "type": "FieldValue",
        "id": "100065"
      },
      {
        "type": "FieldValue",
        "id": "100066"
      },
      {
        "type": "FieldValue",
        "id": "100068"
      },
      {
        "type": "FieldValue",
        "id": "100069"
      },
      {
        "type": "FieldValue",
        "id": "100072"
      },
      {
        "type": "FieldValue",
        "id": "100081"
      },
      {
        "type": "FieldValue",
        "id": "100171",
        "value": "test.oracle.com"
      },
      {
        "type": "FieldValue",
        "id": "100172",
        "value": "Test User"
      },
      {
        "type": "FieldValue",
        "id": "100174"
      },
      {
        "type": "FieldValue",
        "id": "100175"
      },
      {
        "type": "FieldValue",
        "id": "100176"
      },
      {
        "type": "FieldValue",
        "id": "100177"
      },
      {
        "type": "FieldValue",
        "id": "100178"
      },
      {
        "type": "FieldValue",
        "id": "100179"
      },
      {
        "type": "FieldValue",
        "id": "100180"
      },
      {
        "type": "FieldValue",
        "id": "100181",
        "value": "02e0f097ee6a9f8359066e9f005c95e7"
      },
      {
        "type": "FieldValue",
        "id": "100182",
        "value": "d8f3d889e7753a6b6ad99200f8cb678b74a6f20e9fc7216725549c2eec8dc97b"
      },
      {
        "type": "FieldValue",
        "id": "100183"
      },
      {
        "type": "FieldValue",
        "id": "100184"
      },
      {
        "type": "FieldValue",
        "id": "100185"
      },
      {
        "type": "FieldValue",
        "id": "100186"
      },
      {
        "type": "FieldValue",
        "id": "100187"
      },
      {
        "type": "FieldValue",
        "id": "100188",
        "value": "TestUserL88882"
      }
    ],
    "firstName": "Test",
    "isBounceback": "false",
    "isSubscribed": "true",
    "lastName": "User",
    "subscriptionDate": "1420586365"
  }
]