Retrieve an email folder
get
/api/REST/1.0/assets/email/folder/{id}
Retrieves the email folder specified by the
id
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the email folder to retrieve.
Query Parameters
-
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 tocomplete
by default. For more information, see Request depth.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : Folder
Type:
object
Title:
Show Source
Folder
-
createdAt:
string
Read Only:
true
The date and time the email folder was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the email folder. -
currentStatus:
string
The email folder'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 email folder.
-
id:
string
Read Only:
true
Id of the email folder. This is a read-only property. -
isSystem:
string
Read Only:
true
Whether or not the email folder is a system folder. -
name:
string
The name of the email folder.
-
permissions:
string
The permissions for the email folder granted to your current instance. This is a read-only property.
-
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 email folder was last updated. -
updatedBy:
string
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.
Examples
Retrieve the email folder asset with Id #43:
GET /api/REST/1.0/assets/email/folder/43?depth=complete
Response:
{
"type":"Folder",
"id":"43",
"createdAt":"1172514464",
"depth":"complete",
"folderId":"250",
"name":"My Emails",
"updatedAt":"1209057742",
"isSystem":"false"
}