Obtain a List ID for APIs

Get your List ID to use with APIs that require it in order to import to a list

Some Application Programming Interfaces (APIs) or plug-ins require a List ID in order to import to a specific contact list. If you need to provide a List ID you can always go through our Developer Portal or email webservices@constantcontact.com for the integration/application you are using. 

Developers

Developers can use the built-in functionality to get lists in one of the SDKs. They can also use Constant Contact's IO docs or a REST client to make a Get /lists API call.

Non-Developers

Non-Developers can use our API to retrieve the List IDs from their accounts. The information retrieved includes the List Name and List ID. If you are using a 3rd-party integration that is asking you to generate List IDs:

• We have two different versions of our API. The steps you take to generate List IDs will depend on what version of our API the integration you are looking to connect with uses, as they are created through different platforms and are not cross compatible.
• The list ID format will be dependent on whether the integration uses the legacy V2 API (10-digit list ID), or the current V3 API (32-digit list ID) version of our API, so you may need to find out which format you need.

v3 API
v2 API

v3 API

If you need a 32-digit list ID for your integration, then it uses our newer v3 API:

1. Log into your Constant Contact account.
2. Open the v3 API Developer Portal.
3. Click API References.
4. Click Get Lists Collection > GET Lists Collection.
5. Scroll down to the Test this endpoint section.
   
   
    
6. Click the Oauth button and grant permission for the API to access your Constant Contact account.
7. Click the Try button to view all of your lists displayed here, with their 32-digit list IDs. 

   { 
   "list_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
   "name": "General Interest", 
   "favorite": false, 
   "created_at": "2021-01-00T00:00:00Z", 
   "updated_at": "2021-01-00T00:00:00Z"
   }

For more help using our v3 API, please see the API Docs section of our Developer Portal.

v2 API

Follow these steps to use our IO Docs to make the API call through our legacy v2 API:

1. Log into your Constant Contact account.
2. Open the v2 API dashboard. You'll need to sign in, or create a new account and register your app if you don't already have one. The login credentials are not the same as your Constant Contact account.
3. Click Apps & API Keys.
4. Click Applications.
5. Click Create a New Application. This is only used to make the connection with your Constant Contact account to get the List IDs.
   
   
    
6. Enter anything into the Application Name field. You don't need to fill out anything else.
7. Review and check the box to agree to our Terms of Service.
8. Click Register Application.
   
   
    
9. Click the API Tester tab. (The API/Key is prefilled with whatever you put in the Application Name field in step 5.)
10. Click Get Access Token.
    
    
     
11. Click Allow. If you're not logged into your Constant Contact account, you're prompted to log in first.
    
    
     
12. Copy the access token and click Done. We recommend saving the access token future use.
    
    
     
13. Paste the access token into the Enter access token field.
    
    
     
14. Scroll down to the ContactList methods section and click the GET button next to the "Retrieve a collection of ContactLists" option.
15. Click Try it!
    
    
     
16. In the Response Body section, you can see all of your lists displayed with their 10-digit list IDs. 

    {
    "id": "xxxxxxxxxx",
    "name": "General Interest",
    "status": "HIDDEN",
    "created_date": "2021-01-01T00:00:00.000Z",
    "modified_date": "2021-01-01T00:00:00.000Z",
    "contact_count": 0
    
    

For more help using our v2 API, please see the API Docs section of the v2 Developer Portal.

Questions?