Retrieve a list of forms
get
/api/REST/1.0/assets/forms
Retrieves all forms that match the criteria specified by the request parameters. Note: You can also retrieve a list of forms via REST 2.0 by using the endpoint
REST/2.0/assets/forms
.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
The date and time the form 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 : QueryResultForm
Type:
object
Title:
Show Source
QueryResultForm
-
elements:
array elements
Array of form 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 form fields.
Show Source
-
Array of:
object Form
Title:
Form
Nested Schema : Form
Type:
object
Title:
Show Source
Form
-
archived:
string
True if form is archived otherwise False. This is a read-only property.
-
createdAt:
string
Read Only:
true
The date and time the form was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the form. -
currentStatus:
string
The form's current status. Example: draft, active, or complete.
-
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 form.
-
elements:
array elements
Array consisting of form elements.
-
emailAddressFormFieldId:
string
The email address form field entity's unique identifier.
-
html:
string
The asset's raw HTML content.
-
htmlName:
string
The asset's raw HTML name.
-
id:
string
Read Only:
true
Id of the form. This is a read-only property. -
isHidden:
string
Whether the form is an internal form. If
true
, the form is not exposed outside of Eloqua and any form submissions to this form are deleted. -
name:
string
The name of the form.
-
permissions:
string
The permissions for the form granted to your current instance. This is a read-only property.
-
processingSteps:
array processingSteps
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
-
processingType:
string
A list of the form's processing types. For example: externalEmail, externalWebsite, internallyHosted, internalAgentProxyForm.
-
style:
string
The asset's main layout style.
-
submitFailedLandingPageId:
string
The landing page id of the failed submit.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the form.
Nested Schema : elements
Type:
array
Array consisting of form elements.
Show Source
-
Array of:
object FormElement
Title:
FormElement
Nested Schema : processingSteps
Type:
array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, FormStepWebTracking, FormStepGlobalSubscribe, and FormStepSmsPhoneNumberOptInOptOut.
Show Source
-
Array of:
object FormProcessingStep
Title:
FormProcessingStep
Nested Schema : FormElement
Type:
object
Title:
Show Source
FormElement
-
createdAt:
string
Read Only:
true
The date and time the form element was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the form element. -
currentStatus:
string
The form element's current status.
-
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 form element.
-
id:
string
Read Only:
true
Id of the form element. This is a read-only property. -
instructions:
string
The form element's field instructions. Field instructions are optional instructions that help users fill in fields.
-
name:
string
Name of the form element.
-
permissions:
string
The permissions for the form element granted to your current instance.
-
style:
string
The asset's main layout style.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form element was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the form element.
Nested Schema : FormProcessingStep
Type:
object
Title:
Show Source
FormProcessingStep
-
conditionalComparator:
string
The comparator used to validate a condition. Possible values include:
exactly
ornot exactly
. -
conditionalFieldId:
string
The form field id used to compare form fields within a form processing step condition.
-
conditionalType:
string
The type of value the comparator is validating. Possible values include: 'form field' or 'static value'.
-
createdAt:
string
Read Only:
true
The date and time the form processing step was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the form processing step. -
currentStatus:
string
The form processing step's current status.
-
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 form processing step.
-
execute:
string
The conditions for which this form processing step will execute. Possible values include:
always
,conditionally
, andnever
. -
id:
string
Read Only:
true
Id of the form processing step. This is a read-only property. -
isConditionallyNegated:
string
The conditions for which the processing step will execute. If
yes
, the processing step will execute when the conditions are met. Ifno
, the processing step will execute when the conditions are not met. -
name:
string
Name of the form processing step.
-
permissions:
string
The permissions for the form processing step granted to your current instance.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the form processing step was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the form processing step.
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 forms in your database:
GET /api/REST/1.0/assets/forms?count=2
Response:
{
"elements": [
{
"type": "Form",
"currentStatus": "Draft",
"id": "75",
"createdAt": "1554748229",
"createdBy": "52",
"depth": "minimal",
"folderId": "4220",
"name": "The Amazing Form!",
"permissions": "fullControl",
"updatedAt": "1586954686",
"updatedBy": "52",
"archived": "false",
"htmlName": "responsiveform-1554748226676"
},
{
"type": "Form",
"currentStatus": "Draft",
"id": "101",
"createdAt": "1586894543",
"createdBy": "35",
"depth": "minimal",
"folderId": "4124",
"name": "Kiosk Form",
"permissions": "fullControl",
"updatedAt": "1586894551",
"updatedBy": "35",
"archived": "false",
"htmlName": "responsiveform-1586894918064"
}
],
"page": 1,
"pageSize": 2,
"total": 72
}