Our v3 API is now available! Learn more by visiting the v3 developer portal. Creating new v2 API keys is no longer supported.

MyLibrary Trash Folder

Whenever a library file is deleted using either the MyLibrary Individual Files API or the GUI, it is moved to the system's Trash folder. Use this endpoint to view (GET) or to permanently DELETE the files in the Trash folder.

Methods:

Click a method to view its documentation

GET DELETE

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve the upload status for one or more MyLibrary files using the fileId path parameter; separate multiple fileId's with a comma. If the fileId provided does not match any files in the MyLibrary account, the call returns a null set.

DescriptionTOP

Privileges required: N/A

Retrieve MyLibrary product usage information for the authorized Constant Contact account. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve all files in the Trash folder. You can specify the type of files to retrieve using the type query parameter. You can sort the output using the sort_by query parameter. 

DescriptionTOP

Privileges required: mylibrary:folder:read

Retrieve a specific MyLibrary folder using the folderId path parameter. 

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a list of MyLibrary folders and their properties for the authorized Constant Contact account. MyLibrary supports a folder hierarchy with 3 levels of nesting. Primary, child (2nd level) and grandchild (3rd level) folders all have the same properties associated with them. This endpoint returns an empty results array if there are no folders in the user's account.

DescriptionTOP

Privileges required: mylibrary:file:read

The following options  are available when retrieving Library files:

  • Retrieve all files in all folders in the account - do not use any query parameters (except for api_key)
  • Retrieve all files with a specific type - use the type query parameter (ALL, IMAGE, or Document)
  • Retrieve all files from a specific source - use the source query parameter
  • Retrieve a specific file type from a specific source - use both the type and source query parameters

There are many options available for sorting the JSON response using the sort_by query parameter.

DescriptionTOP

Privileges required: mylibrary:file:read

Retrieve a MyLibrary file using the fileId path parameter.

GET: https://api.constantcontact.com/v2/library/folders/trash/files

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

limit

query

50

Specifies the number of results displayed per page of output, from 1 - 1000, default = 50. See Paginated Output for more information on using limit.

sort_by

query

CREATED_DATE_DESC

Specifies how the list of files is sorted; valid sort options are:

  • CREATED_DATE - sorts by date the file was added, ascending (earliest to latest)
  • CREATED_DATE_DESC - (default) sorts by date file was added, descending (latest to earliest)
  • MODIFIED_DATE - sorts by date the file was last modified, ascending (earliest to latest)
  • MODIFIED_DATE_DESC - sorts by date the file was last modified, descending (latest to earliest)
  • NAME - sorts files alphabetically by name, a to z
  • NAME_DESC - sorts files alphabetically by name, z to a
  • SIZE - sorts files by size, smallest to largest
  • SIZE_DESC - sort by file size, largest to smallest
  • DIMENSION - sorts by file dimensions (hxw), smallest to largest
  • DIMENSION_DESC - sorts by file dimensions (hxw), largest to smallest

type

query

ALL

Specifies the type of files to retrieve, ALL, IMAGES, or DOCUMENTS

Response CodesTOP

code

description

200

Request was successful

401

Authentication failure

406

Unsupported Accept Header value, must be application/json

500

Internal server error occurred

StructureTOP

property

type(max length)

description

Example ResponseTOP

{
    "meta": {
        "pagination": {}
    },
    "results": [{
        "name": "menu_form.pdf",
        "id": "9",
        "description": "Menu template for banquets",
        "folder": "Documents",
        "height": 0,
        "width": 0,
        "size": 2171188,
        "url": "https://origin.library.constantcontact.com/doc209/1100325770405/doc/amV3YkP05yStjF2F.pdf",
        "source": "MyComputer",
        "type": "PDF",
        "status": "Deleted",
        "thumbnail": {
            "url": "https://imgssl.constantcontact.com/ui/images1/mlui/mlui_document.png",
            "height": 200,
            "width": 178
        },
        "created_date": "2013-06-19T11:45:41.000-04:00",
        "modified_date": "2013-09-25T15:32:26.000-04:00",
        "folder_id": "-3",
        "is_image": false
    }, {
        "name": "IMG_0257.JPG",
        "id": "7",
        "description": "competition",
        "folder": "Sports_images",
        "height": 320,
        "width": 240,
        "size": 130761,
        "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/7.jpg",
        "source": "MyComputer",
        "type": "JPG",
        "status": "Deleted",
        "thumbnail": {
            "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/7.jpg",
            "height": 200,
            "width": 150
        },
        "created_date": "2013-06-19T11:45:41.000-04:00",
        "modified_date": "2013-09-25T15:32:26.000-04:00",
        "folder_id": "-2",
        "is_image": true
    }, {
        "name": "IMG_0300(1).JPG",
        "id": "6",
        "description": "Rich",
        "folder": "Images",
        "height": 800,
        "width": 600,
        "size": 60225,
        "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/6.jpg",
        "source": "MyComputer",
        "type": "JPG",
        "status": "Deleted",
        "thumbnail": {
            "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/6.jpg",
            "height": 200,
            "width": 150
        },
        "created_date": "2013-06-19T11:45:41.000-04:00",
        "modified_date": "2013-09-25T15:32:26.000-04:00",
        "folder_id": "-1",
        "is_image": true
    }, {
        "name": "IMG_0300.JPG",
        "id": "5",
        "description": "Rich",
        "folder": "Images",
        "height": 600,
        "width": 800,
        "size": 39351,
        "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/5.jpg",
        "source": "MyComputer",
        "type": "JPG",
        "status": "Deleted",
        "thumbnail": {
            "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/5.jpg",
            "height": 150,
            "width": 200
        },
        "created_date": "2013-06-19T11:45:41.000-04:00",
        "modified_date": "2013-09-25T15:32:26.000-04:00",
        "folder_id": "-1",
        "is_image": true
    }, {
        "name": "IMG_0279.JPG",
        "id": "4",
        "description": "pet shopping",
        "folder": "Images",
        "height": 600,
        "width": 800,
        "size": 78071,
        "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/4.jpg",
        "source": "MyComputer",
        "type": "JPG",
        "status": "Deleted",
        "thumbnail": {
            "url": "https://origin.ih.constantcontact.com/fs141/1100325770405/img/4.jpg",
            "height": 150,
            "width": 200
        },
        "created_date": "2013-06-19T11:45:41.000-04:00",
        "modified_date": "2013-09-25T15:32:26.000-04:00",
        "folder_id": "-1",
        "is_image": true
    }]
}