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
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

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