Jump to

• Request
• Response

Retrieve a list of folder contents in the root folder

get

/api/rest/2.0/assets/hyperlink/folder/root/contents

Retrieves all folder contents in the root folder 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.
• lastUpdatedAt: integer
  The date and time the email 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : QueryResultContractObject

Type: object

Title: QueryResultContractObject

Show Source

• elements: array elements
  Array of generic objects.
• 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.

{
    "title":"QueryResultContractObject",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of generic objects.",
            "items":{
                "$ref":"#/definitions/MinimalRest20"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of generic objects.

Show Source

• Array of: object Minimal
  Title: Minimal

{
    "type":"array",
    "description":"Array of generic objects.",
    "items":{
        "$ref":"#/definitions/MinimalRest20"
    }
}

Nested Schema : Minimal

Type: object

Title: Minimal

Show Source

• createdAt: string
  Read Only: true
• createdBy: string
  Read Only: true
• currentStatus: string
• depth: string
  Read Only: true
• description: string
• folderId: string
  Read Only: true
• id: string
  Read Only: true
• name: string
• permissions: array permissions
• scheduledFor: string
  Read Only: true
• sourceTemplateId: string
• type: string
• updatedAt: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "title":"Minimal",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true
        },
        "sourceTemplateId":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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