--- title: "API: Containers" description: How to work with Containers through the Clear Impact Scorecard API. --- [Skip to content](https://support.clearimpact.com/en/2023-api-containers#main-content) English Show submenu for translations [Contact Support](https://support.clearimpact.com/en/kb-tickets/new?hsLang=en) [![Clear-Impact-Logo-Wide-Tagline-RGB.png\]](https://support.clearimpact.com/hs-fs/hubfs/images/Clear-Impact-Logo-Wide-Tagline-RGB.png?height=40&name=Clear-Impact-Logo-Wide-Tagline-RGB.png)](https://support.clearimpact.com/?hsLang=en) Open main navigation Close main navigation - English Show submenu for translations - [Contact Support](https://support.clearimpact.com/en/kb-tickets/new) - [Help Desk](https://support.clearimpact.com/en/kb-tickets/new) [Help Desk](https://support.clearimpact.com/en/kb-tickets/new?hsLang=en) Hi, how can we help you? - There are no suggestions because the search field is empty. 1. [Help Center](https://support.clearimpact.com/en?hsLang=en) 2. [Scorecard Documentation](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en) 3. [API](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#api) # API: Containers The API enables the following interactions with containers: - [Update a container](https://support.clearimpact.com/en/2023-api-containers#UpdateAContainer4) - [Add a container](https://support.clearimpact.com/en/2023-api-containers#AddAContainer2) - [Get container details](https://support.clearimpact.com/en/2023-api-containers#GetContainerDetails3) - [Update a container](https://support.clearimpact.com/en/2023-api-containers#UpdateAContainer4) - [Delete a container](https://support.clearimpact.com/en/2023-api-containers#DeleteAContainer5) ### Container Parameter Definitions - primaryTag\[string\] - The tag used for categorizing this object, between 1-15 characters. You can enter a tag that already exists, or enter a new tag and it will be created. - title \[string\]\* - Container name - containerType \[string\]\* - Container Type; lowercase is preferred. Available Container Types for your instance can be found in [**Object Types**](https://support.clearimpact.com/en/2023-object-types?hsLang=en). - scorecardID \[int\] (optional - parent value) - When retrieving a list of containers, including a scorecard ID narrows the list of containers to only those related to that scorecard.  This parameter can also be used to link a new container to a scorecard, and will be placed in the last sort position on that scorecard. ### Get list of Containers **URL** ``` https://api.resultsscorecard.com/api/containers/list ``` **JSON Input** **Example of input showing all containers in a scorecard** ``` { siteCode: "abc", apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO", scorecardID: 555} ```   **JSON Output** ``` [ { "ID": 1, "title": "New Container", "containerType": "Result", "primaryTag": "ThisIsATag", "createDate": "2013-10-11T00:00:00", "createdBy": "email@domain.org", "modifyDate": "2013-10-13T00:00:00", "modifiedBy": "email@domain.org" }, { "ID": 2, "title": "Newer Container", "containerType": "Result", "primaryTag": "ThisIsATag", "createDate": "2013-11-14T22:51:46.89", "createdBy": "email@domain.org", "modifyDate": "2013-11-14T22:51:46.89", "modifiedBy": "email@domain.org" }] ``` ### Add a Container **URL** ``` https://api.resultsscorecard.com/api/containers/add ``` **JSON Input** ``` { siteCode: "abc", apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO", "primaryTag": "ThisIsATag", "title":"New Container", "containerType": "Result", "scorecardID": "8392"} ``` **JSON Output** ``` { "ID": 5, "title": "New Container", "containerType": "Result", "primaryTag": "ThisIsATag", "createDate": "2013-11-14T22:59:57.0464828-08:00", "createdBy": "email@domain.org", "modifyDate": "2013-11-14T22:59:57.0464828-08:00", "modifiedBy": "email@domain.org"} ``` ### Get Container Details **URL** ``` https://api.resultsscorecard.com/api/containers/details ``` **JSON Input** ``` { siteCode: "abc", apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO", id:1} ``` **JSON Output** ``` { "ID": 1, "title": "New Container", "containerType": "Result", "primaryTag": "ThisIsATag", "createDate": "2013-10-11T00:00:00", "createdBy": "email@domain.org", "modifyDate": "2013-10-13T00:00:00", "modifiedBy": "email@domain.org"} ``` ### Update a Container **URL** ``` https://api.resultsscorecard.com/api/containers/update ``` **JSON Input** ``` { "siteCode": "abc", "apiKey": "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO", "ID": 1, "primaryTag": "ThisIsATag", "title": "Updated Container" "containerType": "Result",} ``` **JSON Output** ``` { "ID": 1, "title": "Updated Container", "containerType": "Result", "primaryTag": "ThisIsATag", "createDate": "2013-10-11T00:00:00", "createdBy": "email@domain.org", "modifyDate": "2013-11-14T23:11:48.8589873-08:00", "modifiedBy": "email@domain.org"} ``` ### Delete a Container **URL** ``` https://api.resultsscorecard.com/api/containers/delete ``` **JSON Input** ``` { siteCode: "abc", apiKey: "eEIzvy0kCu017+D1VjjjI1f52Vmbm+VF2FvO", id:3} ``` **JSON Output** ``` Successfully deleted Container [id]. ``` - [Scorecard Documentation](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#main-content) - [Getting Started](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#getting-started) - [Scorecards](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#scorecards) - [Scorecard Objects](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#scorecard-objects) - [Entering Scorecard Data and Notes](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#entering-scorecard-data-and-notes) - [Viewing or Editing Scorecard Objects and Data](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#viewing-or-editing-scorecard-objects-and-data) - [Actions](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#actions) - [Reports](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#reports) - [Tools](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#tools) - [Site-Level Settings](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#site-level-settings) - [API](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#api) - [Upgrade Notes](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#upgrade-notes) - [FAQ (Scorecard)](https://support.clearimpact.com/en/scorecard-documentation?hsLang=en#faq-scorecard) - [Scorecard Video Tutorials](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#main-content) - [Upgrade Videos](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#upgrade-videos) - [Training Videos](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#training-videos) - [Customer Success Stories](https://support.clearimpact.com/en/scorecard-video-tutorials?hsLang=en#customer-success-stories) - [Compyle Documentation](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#main-content) - [Compyle Overview](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#compyle-overview) - [Participants, Households, and Organizations](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#participants-households-and-organizations) - [Data Collection](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#data-collection) - [Analytics](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#analytics) - [Administration](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#administration) - [Administration - Forms and Fields](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#administration-forms-and-fields) - [Scorecard Feeds](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#scorecard-feeds) - [Compyle Release Notes](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#compyle-release-notes) - [FAQ (Compyle)](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#faq-compyle) - [Referral Network (Compyle-to-Compyle Referrals)](https://support.clearimpact.com/en/compyle-documentation?hsLang=en#referral-network-compyle-to-compyle-referrals) - [Compyle Video Tutorials](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#main-content) - [Compyle Overview Videos](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#compyle-overview-videos) - [Upgrade Webinars](https://support.clearimpact.com/en/compyle-video-tutorials?hsLang=en#upgrade-webinars) - [Control Documentation](https://support.clearimpact.com/en/control-documentation?hsLang=en#main-content) - [Control Overview](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-overview) - [Control for Users](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-for-users) - [Control for Administrators](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-for-administrators) - [Control FAQ](https://support.clearimpact.com/en/control-documentation?hsLang=en#control-faq) - [Clear Impact Suite Overview](https://support.clearimpact.com/en/control-documentation?hsLang=en#clear-impact-suite-overview) - [Suite Release Notes](https://support.clearimpact.com/en/control-documentation?hsLang=en#suite-release-notes) - [Showcase Documentation](https://support.clearimpact.com/en/showcase-documentation?hsLang=en) - [Unlimited Suite Documentation](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#main-content) - [Suite Implementation Materials](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#suite-implementation-materials) - [Managing Partner/Child Sites](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#managing-partner-child-sites) - [Rolling Up Data Across the Unlimited Suite Network](https://support.clearimpact.com/en/unlimited-suite-documentation?hsLang=en#rolling-up-data-across-the-unlimited-suite-network) - [Clear Impact Live Training](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#main-content) - [Free and Customized Training](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#free-and-customized-training) - [Software Courses](https://support.clearimpact.com/en/clear-impact-live-training?hsLang=en#software-courses) - [Collaborate with Clear Impact](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#main-content) - [Coming Attractions & Sneak Peeks](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#coming-attractions-sneak-peeks) - [Resources & Results](https://support.clearimpact.com/en/collaborate-with-clear-impact?hsLang=en#resources-results) [![Logo\_ClearImpact\_White](https://support.clearimpact.com/hs-fs/hubfs/Logo_ClearImpact_White.png?width=341&height=80&name=Logo_ClearImpact_White.png "Logo_ClearImpact_White")](http://www.clearimpact.com) Clear Impact Help Center | support@clearimpact.com Copyright © 2025, Clear Impact, Inc. LLC.