Retrieve a list of landing pages

get

/api/REST/1.0/assets/landingPages

Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

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.
  • Unix timestamp for the date and time the external asset was last updated.
  • Specifies the field by which list results are ordered.
  • 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.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultLandingPage
Type: object
Title: QueryResultLandingPage
Show Source
Nested Schema : elements
Type: array
Array of landing page fields.
Show Source
Nested Schema : LandingPage
Type: object
Title: LandingPage
Show Source
Nested Schema : contentSections
Type: array
A list of content sections contained within the landing page.
Show Source
Nested Schema : dynamicContents
Type: array
A list of dynamic contents contained within the landing page.
Show Source
Nested Schema : files
Type: array
A list of files contained within the landing page.
Show Source
Nested Schema : forms
Type: array
A list of forms contained within the landing page.
Show Source
Nested Schema : HtmlContent
Type: object
Title: HtmlContent
Show Source
Nested Schema : images
Type: array
A list of images contained within the landing page.
Show Source
Nested Schema : ContentSection
Type: object
Title: ContentSection
Show Source
Nested Schema : forms
Type: array
A list of associated Form assets.
Show Source
Nested Schema : images
Type: array
A list of associated Image assets.
Show Source
Nested Schema : Size
Type: object
Title: Size
Show Source
Nested Schema : Form
Type: object
Title: Form
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
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, and FormStepWebTracking.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
Nested Schema : Hyperlink
Type: object
Title: Hyperlink
Show Source
Nested Schema : ImageFile
Type: object
Title: ImageFile
Show Source
Nested Schema : DynamicContent
Type: object
Title: DynamicContent
Show Source
Nested Schema : rules
Type: array
The dynamic content's rules.
Show Source
Nested Schema : DynamicContentRule
Type: object
Title: DynamicContentRule
Show Source
Nested Schema : criteria
Type: array
The criteria of the dynamic content rule.
Show Source
Nested Schema : Criterion
Type: object
Title: Criterion
Show Source
Nested Schema : ImportedFile
Type: object
Title: ImportedFile
Show Source

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 landing pages in your database:


GET /api/REST/1.0/assets/landingPages?count=2 
			

Response:


{
  "elements": [
    {
      "type": "LandingPage",
      "currentStatus": "Draft",
      "id": "21",
      "createdAt": "1424811452",
      "createdBy": "5",
      "depth": "minimal",
      "folderId": "3655",
      "name": "Default Landing Page",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1424811452",
      "updatedBy": "5",
      "excludeFromAuthentication": "false",
      "htmlContent": {
        "type": "StructuredHtmlContent",
        "contentSource": "editor"
      },
      "relativePath": "/Default_LP"
    },
    {
      "type": "LandingPage",
      "currentStatus": "Draft",
      "id": "22",
      "createdAt": "1432583568",
      "createdBy": "9",
      "depth": "minimal",
      "folderId": "3655",
      "name": "Test Landing Page",
      "permissions": [
        "Retrieve",
        "SetSecurity",
        "Delete",
        "Update"
      ],
      "updatedAt": "1432583653",
      "updatedBy": "9",
      "excludeFromAuthentication": "false",
      "htmlContent": {
        "type": "RawHtmlContent",
        "contentSource": "upload"
      },
      "relativePath": "/Test_Landing_Page"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 8
}
			
Back to Top