Retrieve a list of email headers

get

/api/REST/1.0/assets/email/headers

Retrieves all email headers 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 : QueryResultHeader
Type: object
Title: QueryResultHeader
Show Source
Nested Schema : elements
Type: array
Array of header fields.
Show Source
Nested Schema : EmailHeader
Type: object
Title: EmailHeader
Show Source
Nested Schema : fieldMerges
Type: array
A list of associated Field Merges.
Show Source
Nested Schema : FieldMerge
Type: object
Title: FieldMerge
Show Source
Nested Schema : Hyperlink
Type: object
Title: Hyperlink
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 headers in your database:


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

Response:


{
    "elements":[
        {
            "type":"EmailHeader",
            "id":"1",
            "depth":"minimal",
            "folderId":"315",
            "name":"Test Header",
            "permissions":"fullControl",
            "updatedAt":"1243267870"
        },
        {
            "type":"EmailHeader",
            "id":"3",
            "depth":"minimal",
            "folderId":"315",
            "name":"Test Header 2",
            "permissions":"fullControl",
            "updatedAt":"1243267766"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":4
}
			
Back to Top