Retrieve a list of custom object data

get

/api/REST/2.0/data/customObject/{parentId}/instances

Retrieves the data (records) for all custom objects that match the criteria specified by the request parameters.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • 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 minimal by default.
  • Specifies the field by which list results are ordered.
  • Specifies which page of custom object data assets to return (the count parameter defines the number of custom object data assets per page). If the page parameter is not supplied, 1 will be used by default.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultCustomObjectData
Type: object
Title: QueryResultCustomObjectData
Show Source
Nested Schema : elements
Type: array
Array of custom object field elements.
Show Source
Nested Schema : CustomObjectData
Type: object
Title: CustomObjectData
Show Source
Nested Schema : fieldValues
Type: array
Array containing type and id values for all of the fields associated with a given custom object data asset. Custom object date field values must be in Unix time format.
Show Source
Nested Schema : permissions
Type: array
The permissions for the custom object data 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

The following examples demonstrate how to retrieve data for custom objects using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the first 2 custom object data assets in your database:


GET /api/REST/2.0/data/customObject/12/instances?count=2
			

Response:


{
    "elements":[
        {
            "type":"CustomObjectDataAsset",
            "id":"5",
            "createdAt":"1402929826",
            "createdBy":"2",
            "depth":"minimal",
            "description":"Opportunity",
            "name":"Opportunity",
            "updatedAt":"1402929826",
            "updatedBy":"2"
        },
        {
            "type":"CustomObjectDataAsset",
            "id":"6",
            "createdAt":"1402929826",
            "createdBy":"2",
            "depth":"minimal",
            "description":"Purchase History",
            "name":"Purchase History",
            "updatedAt":"1402929827",
            "updatedBy":"2"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":2
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/REST/2.0/data/customObject/12/instances?count=2
			
Back to Top