Retrieve a list of campaign fields.
get
/api/rest/2.0/assets/campaign/fields
Retrieves all campaign fields 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
. The default value isminimal
. -
lastUpdatedAt: integer
The date and time the campaign 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 : QueryResultCampaignField
Type:
object
Title:
Show Source
QueryResultCampaignField
-
elements:
array elements
QueryResult1CampaignField_Field_Elements_Description
-
page:
integer
QueryResult1CampaignField_Field_PageIndex_Description
-
pageSize:
integer
QueryResult1CampaignField_Field_PageSize_Description
-
total:
integer
QueryResult1CampaignField_Field_TotalElements_Description
-
type:
string
QueryResult1CampaignField_Field_Type_Description
Nested Schema : elements
Type:
array
QueryResult1CampaignField_Field_Elements_Description
Show Source
-
Array of:
object CampaignField
Title:
CampaignField
Nested Schema : CampaignField
Type:
object
Title:
Show Source
CampaignField
-
createdAt:
string
Read Only:
true
CampaignField_Field_CreatedAt_Description -
createdBy:
string
Read Only:
true
CampaignField_Field_CreatedBy_Description -
currentStatus:
string
CampaignField_Field_Status_Description
-
dataType:
string
The campaign field's data type. The options are: date, numeric, and text.
-
depth:
string
Read Only:
true
CampaignField_Field_InternalDepth_Description -
description:
string
CampaignField_Field_Description_Description
-
displayIndex:
string
The campaign field's display index.
-
displayType:
string
The campaign field's display type. The options are: multiSelect, singleSelect, and text.
-
folderId:
string
Read Only:
true
CampaignField_Field_FolderId_Description -
id:
string
Read Only:
true
CampaignField_Field_InternalId_Description -
isReadOnly:
string
Whether or not the campaign field is read only.
-
isRequired:
string
Whether or not the campaign field is required.
-
isSystem:
string
Whether or not the campaign field is a system field.
-
name:
string
CampaignField_Field_Name_Description
-
optionListId:
string
The id of the associated option list.
-
permissions:
array permissions
CampaignField_Field_Permissions_Description
-
scheduledFor:
string
Read Only:
true
CampaignField_Field_ScheduledFor_Description -
sourceTemplateId:
string
CampaignField_Field_SourceTemplateId_Description
-
type:
string
CampaignField_Field_Type_Description
-
updatedAt:
string
Read Only:
true
CampaignField_Field_UpdatedAt_Description -
updatedBy:
string
Read Only:
true
CampaignField_Field_UpdatedBy_Description
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.