Our v3 API is now available! Learn more by visiting the v3 developer portal.

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

GET

DescriptionTOP

Privileges required: N/A

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

GET: https://api.constantcontact.com/v2/library/info

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

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

image_root

string

The root URL of the account's image hosting server

max_free_file_num

integer

The maximum number of free MyLibrary files provisioned for the Constant Contact account. If value = 0, then refer to max_premium_space_limit for capacity.

max_premium_space_limit

integer

The total amount of MyLibrary Plus storage space, in bytes, provisioned for the Constant Contact account:

  • if value = 0, refer to max_free_file_num for capacity
  • If value = -1, the account has unlimited storage

max_upload_size_limit

integer

This is the maximum file size (in bytes) that can be uploaded to MyLibrary for this Constant Contact account

+ usage_summary

array

Displays MyLibrary usage data for this Constant Contact account

Example ResponseTOP

{
    "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
}