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

Library File Collection by Folder

Use this endpoint to retrieve Library files from a specific folder.

Methods:

Click a method to view its documentation

GET

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

Get a list of all files in a Library folder specified by the folderId path parameter.

DescriptionTOP

Privileges required: contacts:read

Retrieves a list of all contacts that clicked the email campaign link specified by the linkId and campaignId path parameters (REQUIRED). Use the created_since query parameter to retrieve only the contacts who clicked links on or after the date/time specified. This is useful for sync'ing tracking data across applications.

NOTE: Tracking information is only available for SENT email campaigns

GET: https://api.constantcontact.com/v2/library/folders/{folderId}/files

Test API

name

type

default

description

api_key

query

REQUIRED; The API key for the application

folderId

path

Specifies the folder from which to retrieve files

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 file was created, ascending (earliest to latest)
  • CREATED_DATE_DESC - (default) sorts by date file was created, descending (latest to earliest)
  • MODIFIED_DATE - sorts by date file was last modified, ascending (earliest to latest)
  • MODIFIED_DATE_DESC - sorts by date 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 by file 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

source

query

ALL

Specifies to retrieve files from a particular source:

  • ALL - (default) files from all sources
  • MyComputer
  • Facebook
  • Instagram
  • Shutterstock
  • Mobile

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

404

Folder with the supplied ID was not found

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": "IMG_0341.JPG",
            "id": "9",
            "description": "daisy's in snow 1",
            "folder": "wildflowers",
            "height": 612,
            "width": 792,
            "size": 304560,
            "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/9.jpg",
            "source": "MyComputer",
            "status": "Active",
            "thumbnail": {
                "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/9.jpg",
                "height": 154,
                "width": 200
            },
            "created_date": "2013-09-26T10:52:46.000-04:00",
            "modified_date": "2013-09-26T12:32:41.000-04:00",
            "folder_id": "-1",
            "is_image": true,
            "file_type": "JPG"
        },
        {
            "name": "IMG_0268.JPG",
            "id": "8",
            "description": "cinnamon pointsettias",
            "folder": "wildflowers",
            "height": 480,
            "width": 640,
            "size": 114637,
            "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/8.jpg",
            "source": "MyComputer",
            "status": "Active",
            "thumbnail": {
                "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/8.jpg",
                "height": 150,
                "width": 200
            },
            "created_date": "2013-09-26T10:51:59.000-04:00",
            "modified_date": "2013-09-26T12:32:41.000-04:00",
            "folder_id": "-1",
            "is_image": true,
            "file_type": "JPG"
        },
        {
            "name": "IMG_0267.JPG",
            "id": "7",
            "description": "daisy's in snow 2",
            "folder": "wildflowers",
            "height": 600,
            "width": 800,
            "size": 42217,
            "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/7.jpg",
            "source": "MyComputer",
            "status": "Active",
            "thumbnail": {
                "url": "https://origin.ih.l1.constantcontact.com/fs134/1100394770946/img/7.jpg",
                "height": 150,
                "width": 200
            },
            "created_date": "2013-09-26T10:51:28.000-04:00",
            "modified_date": "2013-09-26T10:51:28.000-04:00",
            "folder_id": "-1",
            "is_image": true,
            "file_type": "JPG"
        }
    ]
}