Retrieve a contact

get

/api/REST/1.0/data/contact/{id}

Retrieves the contact specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • 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.
  • Id of the contact view.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Contact
Type: object
Title: Contact
Show Source
Nested Schema : fieldValues
Type: array
Array containing type and id values for all of the contactFields associated with a given contact.
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
Show Source
  • Read Only: true
    The id of the field to be set to the corresponding value.
  • The asset's type in Eloqua. This is a read-only property.
  • 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.
Back to Top

Examples

Retrieve the contact asset with Id #1:


GET /api/REST/1.0/data/contact/1?depth=complete
			

Response:


{
  "type": "Contact",
  "currentStatus": "Awaiting action",
  "id": "1",
  "createdAt": "1379961590",
  "depth": "complete",
  "name": "C_EmailAddress@oracle.com",
  "updatedAt": "1461868694",
  "accountName": "C_Company",
  "address1": "C_Address1",
  "address2": "C_Address2",
  "address3": "C_Address3",
  "businessPhone": "C_BusPhone",
  "city": "C_City",
  "country": "US",
  "emailAddress": "C_EmailAddress@oracle.com",
  "emailFormatPreference": "unspecified",
  "fax": "C_Fax",
  "fieldValues": [
    {
      "type": "FieldValue",
      "id": "100005"
    },
    {
      "type": "FieldValue",
      "id": "100017",
      "value": "C_Salutation"
    },
    {
      "type": "FieldValue",
      "id": "100023"
    },
    {
      "type": "FieldValue",
      "id": "100024"
    },
    {
      "type": "FieldValue",
      "id": "100032",
      "value": "CLPSB000000000001"
    },
    {
      "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",
      "value": "C_Lead_Source___Most_Recent"
    },
    {
      "type": "FieldValue",
      "id": "100045",
      "value": "C_Lead_Source___Original1"
    },
    {
      "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": "C_FirstName C_LastName"
    },
    {
      "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": "100184"
    },
    {
      "type": "FieldValue",
      "id": "100187"
    },
    {
      "type": "FieldValue",
      "id": "100188"
    },
    {
      "type": "FieldValue",
      "id": "100189",
      "value": "lpatrickL88888"
    },
    {
      "type": "FieldValue",
      "id": "100190"
    },
    {
      "type": "FieldValue",
      "id": "100191"
    },
    {
      "type": "FieldValue",
      "id": "100192"
    },
    {
      "type": "FieldValue",
      "id": "100193"
    },
    {
      "type": "FieldValue",
      "id": "100194"
    },
    {
      "type": "FieldValue",
      "id": "100195"
    }
  ],
  "firstName": "C_FirstName",
  "isBounceback": "false",
  "isSubscribed": "true",
  "lastName": "C_LastName",
  "mobilePhone": "C_MobilePhone",
  "postalCode": "C_Zip_Postal",
  "province": "OR",
  "salesPerson": "C_Salesperson",
  "subscriptionDate": "1461868471",
  "title": "C_Title"
}
			

Note:

For contact assets, the FieldValue id corresponds to the value received when making a GET request to the assets/contact/field/{id} endpoint.
Back to Top