Retrieve a list of accounts

get

/api/REST/1.0/data/accounts

Retrieves all accounts that match the criteria specified by the request parameters

Request

Supported Media Types
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.
  • The date and time the account was last updated. This is a read-only property.
  • Specifies the field by which list results are ordered
  • Set this query parameter to an Eloqua User ID to return all Accounts linked to that Eloqua User. You can link Users to Accounts using the Bulk API. For instructions on how to link Users to Accounts, refer to the linkUsers parameter in this tutorial.
  • Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
  • Id of the account view to filter results. Must be a valid account view id. Example: /api/REST/1.0/data/accounts?viewId=100005.
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : QueryResultAccount
Type: object
Title: QueryResultAccount
Show Source
Nested Schema : elements
Type: array
Array of account fields.
Show Source
Nested Schema : Account
Type: object
Title: Account
Show Source
Nested Schema : crmSystemMappings
Type: array
Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers parameter in this tutorial. This property is also only returned when the request depth is complete.
Show Source
Nested Schema : fieldValues
Type: array
Array containing type and id values for all of the accountFields associated with a given account.
Show Source
Nested Schema : CrmSystemMapping
Type: object
Title: CrmSystemMapping
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
Show Source

204 Response

No matching accounts were found in the search

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 first 2 accounts in your database:


GET /api/REST/1.0/data/accounts?count=2
			

Response:


{
    "elements":[
        {
            "type":"Account",
            "id":"1",
            "createdAt":"1423758306",
            "depth":"minimal",
            "description":"",
            "name":"Cyberdyne Systems",
            "updatedAt":"1423758306",
            "fieldValues":[]
        },
        {
            "type":"Account",
            "id":"2",
            "createdAt":"1423758366",
            "depth":"minimal",
            "description":"",
            "name":"Jarndyce and Jarndyce Law",
            "updatedAt":"1423758366",
            "fieldValues":[]
        }
    ],
    "page":1,
    "pageSize":2,
    "total":7
}
			
Back to Top