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
Header Parameters
Body ()
The request body defines the details of the request.
Root Schema : EntitySearchByIds
Type: object
Title: EntitySearchByIds
Show Source
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
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 : 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: FieldValue
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 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"
  }
]
			
Back to Top