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
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal,partial, andcomplete. Any other values passed are reset tominimalby default. -
lastUpdatedAt: integer
The date and time the account was last updated. This is a read-only property.
-
orderBy: string
Specifies the field by which list results are ordered
-
ownedByUserId: integer
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
linkUsersparameter in this tutorial. -
page: integer
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.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
-
viewId: integer
Id of the account view to filter results. Must be a valid account view id. Example:
/api/REST/1.0/data/accounts?viewId=100005.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultAccount
Type:
objectTitle:
Show Source
QueryResultAccount-
elements:
array elements
Array of account fields.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
arrayArray of account fields.
Show Source
-
Array of:
object Account
Title:
Account
Nested Schema : Account
Type:
objectTitle:
Show Source
Account-
address1:
string
The account's first address.
-
address2:
string
The account's second address.
-
address3:
string
The account's third address.
-
businessPhone:
string
The account's business phone number.
-
city:
string
The account's city.
-
country:
string
The account's country.
-
createdAt:
string
Read Only:
trueThe date and time the account was created, expressed in Unix time. -
createdBy:
string
Read Only:
trueThe login id of the user who created the account. -
crmSystemMappings:
array crmSystemMappings
Lists CRM Users linked to the Account. Each
crmSystemMappingscontains atype,CRMUsername(s), and EloqualoginNamevalues 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 thelinkUsersparameter in this tutorial. This property is also only returned when the request depth iscomplete. -
currentStatus:
string
The account's current status.
-
depth:
string
Read Only:
trueLevel of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal,partial, andcomplete. Any other values passed are reset tocompleteby default. For more information, see Request depth. -
description:
string
The description of the account.
-
fieldValues:
array fieldValues
Array containing
typeandidvalues for all of the accountFields associated with a given account. -
id:
string
Read Only:
trueId of the account. This is a read-only property. -
name:
string
The name of the account.
-
permissions:
string
The permissions for the account granted to your current instance. This is a read-only property.
-
postalCode:
string
The account's postal code.
-
province:
string
The account's province.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
trueUnix timestamp for the date and time the account was last updated. -
updatedBy:
string
Read Only:
trueThe login id of the user that last updated the account.
Nested Schema : crmSystemMappings
Type:
arrayLists CRM Users linked to the Account. Each
Show Source
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.-
Array of:
object CrmSystemMapping
Title:
CrmSystemMapping
Nested Schema : fieldValues
Type:
arrayArray containing
Show Source
type and id values for all of the accountFields associated with a given account.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : CrmSystemMapping
Type:
objectTitle:
Show Source
CrmSystemMapping-
createdAt:
string
Read Only:
true -
createdBy:
string
Read Only:
true -
currentStatus:
string
-
depth:
string
Read Only:
true -
description:
string
-
id:
string
Read Only:
true -
loginName:
string
-
MSDUserName:
string
-
name:
string
-
OSCUserName:
string
-
permissions:
string
-
SFDCUserName:
string
-
SODUserName:
string
-
type:
string
-
updatedAt:
string
Read Only:
true -
updatedBy:
string
Read Only:
true
Nested Schema : FieldValue
Type:
objectTitle:
Show Source
FieldValue-
id:
string
Read Only:
trueThe id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
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.
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
}