Retrieve a list of email folders

get

/api/REST/1.0/assets/email/folders

Retrieves all email folders that match the criteria specified by the request parameters.

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.
  • When the email folder 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.
  • Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultFolder
Type: object
Title: QueryResultFolder
Show Source
Nested Schema : elements
Type: array
Array of folder fields.
Show Source
Nested Schema : Folder
Type: object
Title: Folder
Show Source
  • Read Only: true
    The date and time the email folder was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the email folder.
  • The email folder's current status.
  • Read Only: true
    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 complete by default. For more information, see Request depth.
  • The description of the email folder.
  • Read Only: true
    Id of the email folder. This is a read-only property.
  • Read Only: true
    Whether or not the email folder is a system folder.
  • The name of the email folder.
  • The permissions for the email folder granted to your current instance. This is a read-only property.
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the email folder was last updated.
  • Read Only: true
    The login id of the user that last updated the email folder.

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 email folders in your database:


GET /api/REST/1.0/assets/email/folders?count=2
			

Response:


{
    "elements":[
        {
            "type":"Folder",
            "id":"1",
            "createdAt":"1172514464",
            "depth":"minimal",
            "description":"Root",
            "name":"Email Group Root",
            "updatedAt":"1422471514",
            "updatedBy":"19",
            "isSystem":"true"
        },
        {
            "type":"Folder",
            "id":"2",
            "createdAt":"1172514464",
            "depth":"minimal",
            "folderId":"250",
            "name":"My Emails",
            "updatedAt":"1209057742",
            "isSystem":"false"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":11
}
			
Back to Top