Retrieve a list of contact fields
get
/api/REST/1.0/assets/contact/fields
Retrieves all contact field 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 tominimal
by default. -
lastUpdatedAt: integer
Unix timestamp for the date and time the contact field was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
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.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultContactField
Type:
object
Title:
Show Source
QueryResultContactField
-
elements:
array elements
Array of contact 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:
array
Array of contact fields.
Show Source
-
Array of:
object ContactField
Title:
ContactField
Nested Schema : ContactField
Type:
object
Title:
Show Source
ContactField
-
checkedValue:
string
The checked value.
-
createdAt:
string
Read Only:
true
The date and time the contact field was created, expressed in Unix time. This is a read-only property. -
createdBy:
string
Read Only:
true
The login id of the user who created the contact field. This is a read-only property. -
currentStatus:
string
The email footer's current status.
-
dataType:
string
The contact field's data type. This is a read-only property.
-
defaultValue:
string
The contact field's default value.
-
depth:
string
Read Only:
true
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 tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the contact field.
-
displayType:
string
The contact field's display type.
-
id:
string
Read Only:
true
Id of the contact field. This is a read-only property. -
internalName:
string
The contact field's internal name.
-
isPhoneValidationRequired:
string
ContactField_Field_IsPhoneValidationRequired_Description
-
isReadOnly:
string
Whether or not the contact field is read only.
-
isRequired:
string
Whether or not the contact field is required.
-
isStandard:
string
Whether or not the contact field is standard.
-
name:
string
The name of the contact field.
-
optionListId:
string
The id of the associated option list.
-
outputFormatId:
string
The id of the output format.
-
permissions:
string
The permissions for the contact field granted to your current instance. This is a read-only property.
-
showTrustedVisitorsOnly:
string
Whether or not a contact field is displayed only to trusted visitors.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
uncheckedValue:
string
The unchecked value of a checkbox custom object field.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the contact field was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the contact field. -
updateType:
string
Denotes under what circumstances the contact field is updated.
204 Response
No matching contact fields 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 contact fields in your database:
GET /api/REST/1.0/assets/contact/fields?count=2
Response:
{
"elements":[
{
"type":"ContactField",
"id":"100001",
"createdAt":"-2208970800",
"depth":"minimal",
"name":"Email Address",
"updatedAt":"-2208970800"
},
{
"type":"ContactField",
"id":"100002",
"createdAt":"-2208970800",
"depth":"minimal",
"name":"First Name",
"updatedAt":"1402929830",
"updatedBy":"10"
}
],
"page":1,
"pageSize":2,
"total":61
}