Library Summary Information
Use this endpoint to retrieve Library usage information, including total number of folders, images & documents, and storage space used in bytes for images, documents, and in total.
Methods:
Click a method to view its documentation
Description TOP
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.
Description TOP
Privileges required : N/A
Retrieve MyLibrary product usage information for the authorized Constant Contact account.
Description TOP
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.
Description TOP
Privileges required : mylibrary:folder:read
Retrieve a specific MyLibrary folder using the
folderId
path parameter.
Description TOP
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.
Description TOP
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
typequery parameter (ALL, IMAGE, or Document) -
Retrieve all files from a specific source - use the
sourcequery parameter -
Retrieve a specific file type from a specific source - use both the
typeandsourcequery parameters
There are many options available for sorting the JSON response using the
sort_by
query parameter.
Description TOP
Privileges required : mylibrary:file:read
Retrieve a MyLibrary file using the
fileId
path parameter.
Description TOP
Privileges : account:read
Retrieve account-related information for the authorized Constant Contact account.
|
GET: https://api.constantcontact.com/v2/library/info |
|||
|
name |
type |
default |
description |
|---|---|---|---|
|
api_key |
query |
|
REQUIRED; The API key for the application |
Response Codes TOP
|
code |
description |
|---|---|
|
200 |
Request was successful |
|
401 |
Authentication failure |
|
406 |
Unsupported accept header value, must be application/json |
|
500 |
Internal server error occurred |
Structure TOP
|
property |
type (max length) |
description |
|---|
Example Response TOP
{
"max_free_file_num" : 0,
"max_premium_space_limit" : 262144000,
"image_root" : "https://origin.ih.constantcontact.com",
"usage_summary" : {
"folder_count" : 6,
"file_count" : 637,
"image_count" : 492,
"document_count" : 145,
"total_bytes_used" : 36240602,
"image_bytes_used" : 34628484,
"document_bytes_used" : 1612118,
"total_bytes_remaining" : 225903398,
"free_files_remaining" : 0
},
"max_upload_size_limit" : 5242880
}